diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 71 |
1 files changed, 44 insertions, 27 deletions
@@ -1,61 +1,78 @@ # Nest Starter App ## Description -A starter app with LTI1p0 enabled for NestJS +A starter app with Postgres, NestJS, and React + +## Prerequisites +### asdf-vm +Tool versions are managed using `asdf-vm`. You will need to have `asdf-vm` installed first. ## Setup +### Tool versions +Install the tool versions by running +```bash +$ asdf install +``` + +### Install yarn +We will use `yarn` instead of `npm` for package managment +```bash +$ npm install -g yarn +``` + +### .env Create a file in the root called `.env` and copy the contents of `.env.example` -## SSL -Create a ssl key and certificate an place them in the root directory +### Dependencies +To install the dependencies run +```bash +$ yarn # this is same thing as `yarn install` +``` +### Database +Create the database ```bash -$ openssl req -x509 -newkey rsa:4096 -keyout private-key.pem -out public-cert.pem -sha256 -nodes +$ pc_ctl start # this starts postgres +$ createdb neststarterappdevelopement # creates a postgres database ``` -Where this key will only be used for development you can leave all of the information blank. -## Installation +Run the migrations +```bash +yarn db:migrate +``` + +Migrations need to be run again everytime a new migration is created + +### SSL +Create a ssl key and certificate an place them in the root directory ```bash -$ npm install +$ openssl req -x509 -newkey rsa:4096 -keyout private-key.pem -out public-cert.pem -sha256 -nodes ``` +Where this key will only be used for development you can leave all of the information blank. ## Running the app ```bash # development -$ npm run start +$ yarn start # watch mode -$ npm run start:dev +$ yarn start:dev # production mode -$ npm run start:prod +$ yarn start:prod ``` ## Test ```bash # unit tests -$ npm run test +$ yarn test # e2e tests -$ npm run test:e2e +$ yarn test:e2e # test coverage -$ npm run test:cov +$ yarn test:cov ``` - -## Support - -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). - -## Stay in touch - -- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) - -## License - -Nest is [MIT licensed](LICENSE). |