docs: add information for development
This commit is contained in:
		| @@ -1,2 +1 @@ | ||||
| ARG VARIANT="16" | ||||
| FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} | ||||
| FROM mcr.microsoft.com/devcontainers/javascript-node:16 | ||||
|   | ||||
							
								
								
									
										13
									
								
								.env.example
									
									
									
									
									
								
							
							
						
						
									
										13
									
								
								.env.example
									
									
									
									
									
								
							| @@ -1,21 +1,22 @@ | ||||
| COMPOSE_PROJECT_NAME=thream-api | ||||
| NODE_ENV=development | ||||
| API_URL=http://localhost:8080 | ||||
| HOST=0.0.0.0 | ||||
| PORT=8080 | ||||
| COMPOSE_PROJECT_NAME=thream-api | ||||
| DATABASE_URL=postgresql://user:password@thream-database:5432/thream | ||||
| DISCORD_CLIENT_ID= | ||||
| DISCORD_CLIENT_SECRET= | ||||
| EMAIL_HOST=thream-maildev | ||||
| EMAIL_PASSWORD=password | ||||
| EMAIL_PORT=25 | ||||
| EMAIL_USER=no-reply@thream.fr | ||||
| FILE_UPLOADS_API_KEY=apiKeySecret | ||||
| FILE_UPLOADS_API_URL=http://host.docker.internal:8000 | ||||
| DISCORD_CLIENT_ID= | ||||
| DISCORD_CLIENT_SECRET= | ||||
| GITHUB_CLIENT_ID= | ||||
| GITHUB_CLIENT_SECRET= | ||||
| GOOGLE_CLIENT_ID= | ||||
| GOOGLE_CLIENT_SECRET= | ||||
| HOST=0.0.0.0 | ||||
| JWT_ACCESS_EXPIRES_IN=15 minutes | ||||
| # You can generate JWT secrets with the `npm run generate:jwt-secret` command. | ||||
| JWT_ACCESS_SECRET=accessTokenSecret | ||||
| JWT_REFRESH_SECRET=refreshTokenSecret | ||||
| NODE_ENV=development | ||||
| PORT=8080 | ||||
|   | ||||
| @@ -58,9 +58,9 @@ Scopes define what part of the code changed. | ||||
| ### Examples | ||||
|  | ||||
| ```sh | ||||
| git commit -m "feat(services): add POST /users/signup" | ||||
| git commit -m "feat: add POST /users/signup" | ||||
| git commit -m "docs(readme): update installation process" | ||||
| git commit -m "fix(services): should emit events to connected users" | ||||
| git commit -m "fix: should emit events to connected users" | ||||
| ``` | ||||
|  | ||||
| ## Directory Structure | ||||
| @@ -120,3 +120,5 @@ The folders after `src/services` : is the real path of the routes in the API exc | ||||
| folders starting and ending with `__` like `__test__` or `__utils__`. | ||||
|  | ||||
| The filenames correspond to the HTTP methods used (`get`, `post`, `put`, `delete`). | ||||
|  | ||||
| You can generate the boilerplate code for a new service with the `npm run generate` command. | ||||
|   | ||||
		Reference in New Issue
	
	Block a user