You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds support for [devcontainers](https://containers.dev/), this should
make onboarding easier and should allow (especially simpler)
contributions entirely online via Github Codespaces 🚀
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -37,10 +37,13 @@ For first time contributions you can also filter the issues labeled with "[good
37
37
## Development Environment
38
38
If you would like to contribute you can fork this repository and create a branch specific to the project you are working on.
39
39
40
-
There are two options for developing:
40
+
There are three options for developing:
41
41
1. Yarn
42
-
- This is the traditional way to get an envrionment stood up. Run `yarn` to install the dependencies followed by `yarn start:browser` to start the development server. You will then be able to access Actual at `localhost:3001`.
42
+
- This is the traditional way to get an environment stood up. Run `yarn` to install the dependencies followed by `yarn start:browser` to start the development server. You will then be able to access Actual at `localhost:3001`.
43
43
2. Docker Compose
44
44
- If you prefer to work with docker containers, a `docker-compose.yml` file is included. Run `docker compose up -d` to start Actual. It will be accessible at `localhost:3001`.
45
+
3. Dev container
46
+
- Directly integrated in some IDEs, dependencies will be installed automatically as you enter the container.
47
+
- Use your preferred method to `npm start` the project, your IDE should expose the project on your `localhost` for you.
45
48
46
49
Both options above will dynamically update as you make changes to files. If you are making changes to the front end UI, you may have to reload the page to see any changes you make.
0 commit comments