Skip to content

Commit

Permalink
Add information about using GitHub codespace
Browse files Browse the repository at this point in the history
  • Loading branch information
anders-kiaer committed Sep 26, 2023
1 parent fd1d428 commit 76c755a
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,20 @@ git push upstream <featurebranchname>:review --force
```
The `main` branch only accepts commits through pull requests.

NB: Note that Radix will always use the `radixconfig.yml` as it is in `main` branch (unless changed in Radix UI).
NB: Note that Radix will always use the `radixconfig.yml` as it is in `main` branch (unless changed in Radix UI).

### Usage in GitHub codespaces

Using the standard GitHub codespace image, you can easily start up the application by running
the same command as locally:
```
docker-compose up
```
in the terminal. When using GitHub codespaces you do not have to create the `.env` file since
environment variables are automatically set up for you at startup through repository settings.
Note that you need to have at least "collaborator" role in the repository in order to have
environment variables automatically set up.

When you start up the docker containers, GitHub codespace will automatically make a link where
you can access the application in development mode (i.e. changes you do the code will automatically
be reflected in the application).

0 comments on commit 76c755a

Please sign in to comment.