Skip to content

Commit

Permalink
Tidy up the setup instructions (#470)
Browse files Browse the repository at this point in the history
  • Loading branch information
zerolab authored Apr 4, 2024
2 parents 76fdc3e + b2da2a6 commit cfbb0de
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ To create a new superuser locally, run:
make superuser
```

### Setting up the cache table

This should only need to be done the first time you set up a new database:

```
make sh
python manage.py createcachetable
```

### Pulling production data / media

If you'd like to work with production data and have access, run the following commands:
Expand Down Expand Up @@ -99,18 +108,22 @@ Within the VM shell, you can run `./manage.py` to run any Django management comm
- `dj <command> [args]` - Runs a management command (eg, `dj shell`)
- `djrun` - Starts the webserver on port 8000

## Frontend tooling
## Frontend tooling (Docker and Vagrant)

To install and build the frontend:
During the initial setup, you will need to build the frontend assets:

- `nvm use` to use the suggested node version (requires [nvm](https://github.com/nvm-sh/nvm), [fnm](https://github.com/Schniz/fnm) or similar. You'll also need to run `nvm install` to install and activate the version of node required for the project)
- `npm i` to install dependencies
- `npm run build` to compile CSS & JS

Other common commands:
If you are editing frontend assets, you will also need to rebuild assets while
you edit:

- `npm run start` start the Webpack build in watch mode, without live-reload
- `npm run start:reload` start the Webpack server build on port 3000 with live-reload

Other common commands:

- `npm run lint` lint JS & CSS files
- `npm run format` format files

Expand Down

0 comments on commit cfbb0de

Please sign in to comment.