Browse Source

Merge 8dd4b6651a into c0ae6f848a

pull/6576/merge
Omkar Gujja 4 days ago
committed by GitHub
parent
commit
8667736795
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 18
      DEVELOPMENT.md
  2. 1
      package.json

18
DEVELOPMENT.md

@ -14,25 +14,23 @@
1. Run `npm install`
1. Run `docker compose -f docker/docker-compose.dev.yml up -d` to start [PostgreSQL](https://www.postgresql.org) and [Redis](https://redis.io)
1. Run `npm run database:setup` to initialize the database schema
1. Start the [server](#start-server) and the [client](#start-client)
1. Start the [development environment](#start-development-environment) (recommended) or start [server](#start-server) and [client](#start-client) separately
1. Open https://localhost:4200/en in your browser
1. Create a new user via _Get Started_ (this first user will get the role `ADMIN`)
### Start Server
### Start Development Environment
#### Debug
Run `npm run watch:server` and click _Debug API_ in [Visual Studio Code](https://code.visualstudio.com)
#### Parallel Development (Recommended)
#### Serve
Run `npm run dev` to start both server and client simultaneously with hot reload:
Run `npm run start:server`
#### English (Default)
### Start Client
- Client: https://localhost:4200/en
#### English (Default)
#### Debug
Run `npm run start:client` and open https://localhost:4200/en in your browser.
Run `npm run watch:server` and click _Debug API_ in [Visual Studio Code](https://code.visualstudio.com)
#### Other Languages

1
package.json

@ -42,6 +42,7 @@
"start:client": "nx run client:copy-assets && nx run client:serve --configuration=development-en --hmr -o",
"start:production": "npm run database:migrate && npm run database:seed && node main",
"start:server": "nx run api:copy-assets && nx run api:serve --watch",
"dev": "nx run api:copy-assets && nx run client:copy-assets && nx run-many --targets=serve --parallel --projects=api,client --configuration=development-en && nx run client:serve --configuration=development-en --hmr -o",
"start:storybook": "nx run ui:storybook",
"test": "npx dotenv-cli -e .env.example -- npx nx run-many --target=test --all --parallel=4",
"test:api": "npx dotenv-cli -e .env.example -- nx test api",

Loading…
Cancel
Save