Skip to content

Commit

Permalink
Update Dev Environment Setup Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Campbell committed Aug 26, 2020
1 parent 889ebfb commit 84897fb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Dev Environment Setup Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@


## Setup
- The webqueue2 API uses `gunicorn` as a WSGI server and this does not run on Windows. If you're developing on Windows, look into Ubuntu on [WSL2](https://docs.microsoft.com/en-us/windows/wsl/wsl2-index) or use a virtual machine.
- The webqueue2 API uses `gunicorn` as a WSGI server and this does not run on Windows. If you're developing on Windows use a virtual machine.

- webqueue2 uses npm and create-react-app to manage itself. You can learn more about npm [here](https://nodesource.com/blog/an-absolute-beginners-guide-to-using-npm/) and create-react-app [here](https://create-react-app.dev/docs/getting-started/).

Expand All @@ -35,9 +35,9 @@ npm install
#### Using npm
There are four npm scripts included in this project:

- `npm run start`: This will start a local development server on [localhost:3000](http://localhost:3000) and launch your default browser at that address. As you save changes in /public and/or /src you'll see your changes in the browser. (API requests are automatically proxied to the API server.)
- `npm run start:frontend`: This will start a development server on [localhost:3000](http://localhost:3000). (If the server is on your local machine, this will also launch your default browser at that address.) As you save changes in /public and/or /src you'll see your changes in the browser. (API requests are automatically proxied to the API server.)

- `npm run start-api`: This will start a local WSGI server on [localhost:5000](http://localhost:5000) to access the API. **Note:** You will need to add Python to your PATH variable.
- `npm run start:api`: This will start a local WSGI server on [localhost:5000](http://localhost:5000) to access the API. **Note:** You will need to add Python to your PATH variable if it is not already.

- `npm run build`: This will build a static version of the site in /build ready to be placed in the document root of any web server.

Expand Down

0 comments on commit 84897fb

Please sign in to comment.