Update readme guidelines and added bash scripts

Author: fsabado00

.gitignore

@@ -36,6 +36,7 @@ frontend/.idea
 backend/.git
 frontend/.git
 
+backend/dbdata-old
 backend/dbdata
 
 # TODO: For demo purposes we allow .env to be pushed

README.md

@@ -26,39 +26,64 @@
 * Docker
 * Nginx
 
+## Setup
 
+### Run and Deploy Instantly
 
+### This would run the script to install and setup backend and frontend apps
+```bash
+$ chmod +x start.sh
+$ chmod +x stop.sh
+```
 
-## Setup
 
+#### Start the docker apps
+```bash
+$ ./start.sh
+```
 
 
-### Run and Deploy Instantly 
+#### Stop the docker apps
 ```bash
-$ docker-compose up
+$ ./stop.sh
+```
 
-or
+<br>
 
-$ docker-compose up --build
-```
 
+---
 
-### Run Individually
+### Run Manually
 
 #### 1) Backend (default url http://localhost:8888)
 
 ```bash
 $ cd backend
+
+# install deps
 $ pnpm install
+
+# run mysql db server
 $ docker-compose up
+
+# run prisma migration
+$ npx prisma migrate dev
+
+# (optional) add predefined data to db
+$ npx prisma db seed
+
+# run backend app
+$ pnpm run start
+or
+$ pnpm run start:dev
 ````
 
 
 #### 2) Frontend (default url http://localhost:8080)
 ```bash
 $ cd frontend
 $ pnpm install
-$ pnpm run start
+$ pnpm run dev
 ````
 
 

backend/README.md

@@ -20,6 +20,16 @@ $ pnpm run start:dev
 $ pnpm run start:prod
 ```
 
+
+> Once backend mysql db is running we need to run Prisma CLI to apply migrations and generate the Prisma client:
+
+```bash
+$ npx prisma migrate dev
+
+$ npx prisma generate
+```
+
+
 ## Test
 
 ```bash
@@ -33,13 +43,6 @@ $ pnpm run test:e2e
 $ pnpm run test:cov
 ```
 
-##
-Use Prisma CLI to apply migrations and generate the Prisma client:
-
-```bash
-$ npx prisma migrate dev
-$ npx prisma generate
-```
 
 ### Seed the Cafes and Employees (add dummy data)
 
@@ -57,7 +60,7 @@ Then just to be sure run again...
 $ npx prisma migrate dev
 ```
 
-After that, seed data is now added.
+After that, seeded data is now planted in the db ;-)
 
 
 ## API

backend/docker-compose.yaml

@@ -9,17 +9,3 @@ services:
     environment:
       - MYSQL_ROOT_PASSWORD=password
       - MYSQL_DATABASE=cedb
-
-
-  backend:
-    build: .
-    depends_on:
-      - db
-    ports:
-      - '8888:8888'
-    volumes:
-      - .:/app
-    environment:
-      - DATABASE_URL=mysql://root:password@db:3306/cedb
-      - NODE_DOCKER_PORT=8888
-

backend/src/main.ts

@@ -13,6 +13,6 @@ async function bootstrap() {
   };
 
   app.enableCors(options);
-  await app.listen(port);
+  await app.listen(port || 8888);
 }
 bootstrap();

frontend/README.md

@@ -3,7 +3,7 @@
 This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
 
 
-### Features
+## Features
 
 - ⚡ [React.js](https://react.dev/)
 - ⚡ [Material-UI](https://mui.com/)
@@ -25,24 +25,25 @@ This template provides a minimal setup to get React working in Vite with HMR and
 Run the following command on your local environment:
 
 ```shell
-git clone --depth=1 https://github.com/sonht113/react-boilerplate-for-starter.git
-cd my-project-name
-pnpm install
+$ pnpm install
 ```
 
 Then, you can run locally in development mode with live reload:
 
 ```shell
-pnpm run dev
+$ pnpm run dev
 ```
 
-Open http://localhost:5173 with your favorite browser to see your project.
+Open http://localhost:5173 (development) with your favorite browser to see your project.
 
+> **Important:** 
+> Backend should be already running at http://localhost:8888 or whatever the .env settings is configured
+
+##  Project Structure
 ```shell
 .
 ├── README.md                       # README file
 ├── .github                         # GitHub folder
-├── .husky                          # Husky configuration
 ├── public                          # Public assets folder
 ├── src
 │   ├── apis                        # Common apis folder

start.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Install pnpm globally
+echo "===========[ Install local pnpm globally...] ============"
+npm install -g pnpm
+
+# Navigate to backend directory and install dependencies
+echo "===========[ Install backend deps...] ============"
+cd backend
+pwd
+pnpm install
+
+# Return to the root directory and start Docker containers
+echo "===========[ Run main docker command...] ============"
+cd ..
+pwd
+docker-compose up -d
+
+# Navigate back to backend directory and run Prisma migrations
+echo "===========[ Run prisma migrate in backend...] ============"
+cd backend
+pwd
+npx prisma db seed
+npx prisma migrate dev
+
+echo "===========[ Setup complete! ] ============"

stop.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo "===========[ Stop docker] ============"
+docker-compose down