fix: Environment installation (#90)

* feat: rewrite .env.example

* feat: add prisma push command

* fix: put a valid database url by default and documentate it

* docs: Fix README

* chore(ide): Update data source

* chore: Improve reset and seed make commands

* docs: Add disclaimer for hardcoded credentials

* docs: Add how generate NEXTAUTH_SECRET

* fix: rewrite .env.example

* fix: improve .env.example

Author: vbetsch

.env.example

@@ -1,15 +1,20 @@
+# For the local environment, you don't need to replace values
+# For others environments, you need to replace at least DATABASE_USER, DATABASE_PASSWORD, DATABASE_HOST, DATABASE_URL, NEXTAUTH_SECRET and NEXTAUTH_URL
+
 # Database
-DATABASE_PROVIDER=your_database_provider
-DATABASE_NAME=your_database_name
-DATABASE_USER=your_database_user
-DATABASE_PASSWORD=your_database_user_password
-DATABASE_HOST=your_database_host
-DATABASE_PORT=your_database_port
-DATABASE_URL=your_database_url
+DATABASE_PROVIDER="postgresql"
+DATABASE_NAME="locklite_app"
+DATABASE_USER="locklite"
+DATABASE_PASSWORD="locklite"
+DATABASE_HOST="localhost"
+DATABASE_PORT=5432
+#DATABASE_URL="postgres://DATABASE_USER:DATABASE_PASSWORD@DATABASE_HOST:DATABASE_PORT/DATABASE_NAME"
+DATABASE_URL="postgres://locklite:locklite@localhost:5432/locklite_app"
 
 # Next Auth
-NEXTAUTH_SECRET=your_nextauth_secret
-NEXTAUTH_URL=your_nextauth_url
+# Generate your own unique secret for each environment. You can use `openssl rand -base64 32` or `npx next-auth secret` to generate one.
+NEXTAUTH_SECRET="your_nextauth_secret"
+NEXTAUTH_URL="http://localhost:3000"
 
 # Security
-BCRYPT_SALT_ROUNDS=your_bcrypt_salt_rounds
+BCRYPT_SALT_ROUNDS=12

.idea/dataSources.xml

@@ -53,18 +53,21 @@ migrate: up
 	fi
 	npm run prisma:migrate "$(MIGRATION_NAME)"
 
-seed: up
+reset: up
 	npm run prisma:reset
+
+seed: up
 	npm run prisma:seed
 
 clean:
 	rm -rf .next node_modules package-lock.json
 	npm install
 
-.PHONY: up down dev build lint format tests tests-shared tests-api tests-ui coverage migrate seed clean
+.PHONY: up down dev build lint format tests tests-shared tests-api tests-ui coverage migrate reset seed clean
 
 # Aliases
 run: up dev
 checks: lint tests
+reset_db: reset seed
 ci: lint coverage build
 .PHONY: run checks ci

Makefile

@@ -44,35 +44,41 @@ We recommend using a WSL for this project. If so, please follow the [Linux](#lin
 
 ### Installation
 
-1. Create a `.env` file by copying the example file `.env.example` file. Replace the default values with your own.
+1. Create a `.env` file by copying the example file `.env.example` file. These values are only for the local environment, you can modify it if you want.
 
-2. You need to install NodeJS packages
+2. Start docker services with the following command
 
 ```shell
-npm install
+docker-compose up -d
 ```
 
-### Getting Started
+3. You need to install NodeJS packages
+
+```shell
+npm install
+```
 
-1. Start docker services with the following command
+4. Generate database schema
 
 ```shell
-docker-compose up -d
+npm run prisma:push
 ```
 
-2. Generate data with Prisma seed
+5. Generate data with Prisma seed
 
 ```shell
 npm run prisma:seed
 ```
 
-3. Launch the application in development mode
+### Getting Started
+
+1. Launch the application in development mode
 
 ```shell
 npm run dev
 ```
 
-4. Well done, the application is running!
+2. Well done, the application is running!
 
 - UI : http://localhost:3000/ui (homepage)
 - API : http://localhost:3000/api/docs (Swagger documentation)
@@ -104,35 +110,41 @@ npm run prisma:seed
 
 ### Installation
 
-1. Create a `.env` file by copying the example file `.env.example` file. Replace the default values with your own.
+1. Create a `.env` file by copying the example file `.env.example` file. You can modify it if you want.
 
-2. You need to install NodeJS packages
+2. Start docker services with the following command
 
 ```shell
-npm install
+docker-compose up -d
 ```
 
-### Getting Started
+3. You need to install NodeJS packages
+
+```shell
+npm install
+```
 
-1. Start docker services with the following command
+4. Generate database schema
 
 ```shell
-docker-compose up -d
+npm run prisma:push
 ```
 
-2. Generate data with Prisma seed
+5. Generate data with Prisma seed
 
 ```shell
 npm run prisma:seed
 ```
 
-3. Launch the application in development mode
+### Getting Started
+
+1. Launch the application in development mode
 
 ```shell
 npm run dev
 ```
 
-4. Well done, the application is running!
+2. Well done, the application is running!
 
 - UI : http://localhost:3000/ui (homepage)
 - API : http://localhost:3000/api/docs (Swagger documentation)
@@ -164,35 +176,41 @@ npm run prisma:seed
 
 ### Installation
 
-1. Create a `.env` file by copying the example file `.env.example` file. Replace the default values with your own.
+1. Create a `.env` file by copying the example file `.env.example` file. You can modify it if you want.
 
-2. You need to install NodeJS packages
+2. Start docker services with the following command
 
 ```shell
-npm install
+docker-compose up -d
 ```
 
-### Getting Started
+3. You need to install NodeJS packages
 
-1. Start docker services with the following command
+```shell
+npm install
+```
+
+4. Generate database schema
 
 ```shell
-docker-compose up -d
+npm run prisma:push
 ```
 
-2. Generate data with Prisma seed
+5. Generate data with Prisma seed
 
 ```shell
 npm run prisma:seed
 ```
 
-3. Launch the application in development mode
+### Getting Started
+
+1. Launch the application in development mode
 
 ```shell
 npm run dev
 ```
 
-4. Well done, the application is running!
+2. Well done, the application is running!
 
 - UI : http://localhost:3000/ui (homepage)
 - API : http://localhost:3000/api/docs (Swagger documentation)

README.md

@@ -18,6 +18,7 @@
     "prisma:reset": "prisma migrate reset",
     "prisma:migrate": "prisma migrate dev --name",
     "prisma:generate": "prisma generate",
+    "prisma:push": "prisma db push",
     "prisma:seed": "tsx src/modules/api/infra/prisma/seed/seed.ts"
   },
   "dependencies": {