fix: add .env_sample file with initial configuration

Author: msrajawat298

.env_sample

@@ -0,0 +1,16 @@
+JWT_SECRET=vitabletech-secret-key
+PORT=5000
+DB_HOST=db
+DB_USER=root
+DB_PASSWORD=notSecureChangeMe
+DB_NAME=testdb
+DB_DIALECT=mysql
+DB_POOL_MAX=5
+DB_POOL_MIN=0
+DB_POOL_ACQUIRE=30000
+DB_POOL_IDLE=10000
+NODE_ENV=development
+APP_PORT=80
+PHPMYADMIN_PORT=8081
+[email protected]
+GIT_USERNAME=msrajawat298

README.md

@@ -22,7 +22,7 @@ git clone https://github.com/vitabletech/node-express-api-bootstrap.git
 cd node-express-api-bootstrap
 ```
 
-3. Edit the `.env` file to configure your environment variables. You may also need to adjust the `docker-compose.yml` file if you wish to use non-default settings.
+3. Rename `.env_sample` to .env andEdit the `.env` file to configure your environment variables. You may also need to adjust the `docker-compose.yml` file if you wish to use non-default settings.
 
 ## Running the Application
 
@@ -45,14 +45,14 @@ docker exec -it vitabletech-node-app /bin/bash
 5. Inside the container, run the following command to synchronize the database:
 
 ```bash
-npm run sync-db
+npm run sync-db && npm run seed
 ```
 
 This command will automatically create the required tables.
 
 6. Once the database synchronization is complete, you can start working on the application.
 
-7. Access the Node.js application at [http://localhost:3000/](http://localhost:3000/).
+7. Access the Node.js application at [http://localhost/](http://localhost/).
 
 ## Enjoy!
 

config/config.json

@@ -3,7 +3,7 @@
     "username": "root",
     "password": "notSecureChangeMe",
     "database": "testdb",
-    "host": "localhost",
+    "host": "db",
     "dialect": "mysql",
     "logging": "console.log"
   },

docker-compose.yml

@@ -7,9 +7,9 @@ services:
     volumes:
       - .:/app
     working_dir: /app
-    command: bash -c "npm install && npm run dev"
+    command: bash -c "chmod +x ./setup.sh && ./setup.sh"
     ports:
-      - 3000:3000
+      - "${APP_PORT}:${PORT}" # Use the port number defined in .env for the host
     env_file:
       - .env
 
@@ -20,15 +20,15 @@ services:
     ports:
       - 3306:3306
     environment:
-      MYSQL_ROOT_PASSWORD: notSecureChangeMe
+      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
 
   phpmyadmin:
     container_name: vitabletech-phpmyadmin
     image: phpmyadmin
     restart: always
     ports:
-      - 8080:80
+      - ${PHPMYADMIN_PORT}:80
     environment:
       PMA_ARBITRARY: 1
       PMA_USER: root
-      PMA_PASSWORD: notSecureChangeMe
+      PMA_PASSWORD: ${DB_PASSWORD}

setup.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+
+# Set up Git
+git config --global user.email $GIT_EMAIL
+git config --global user.name $GIT_USERNAME
+
+# Install dependencies
+npm install
+
+# Run the appropriate command based on the NODE_ENV variable
+if [[ $NODE_ENV == 'development' ]]; then
+    npm run dev
+else
+    npm start
+fi
+
+# Keep the container running
+tail -f /dev/null