Merge pull request #11 from techstartucalgary/build/prisma-config

Build/prisma config

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .env
 dist
+migrations

README.md

@@ -4,7 +4,7 @@
 
 All the code is located in the `backend/src` directory. The backend is written using [Node.js](https://nodejs.org/en/) and [Express](https://expressjs.com/).
 
-### 🏃 Quickstart with Node.js
+### 🏃 Quickstart
 
 1. Make sure you have `Node.js` and `NPM` installed on your machine. Click [here](https://nodejs.org/en/) to download and install Node.js. Make sure you install the LTS version. NPM is installed automatically when you install Node.js.
 
@@ -22,156 +22,116 @@ npm -v
 
 4. If you see the version number of `Node.js` and `npm` then you are good to go. If not, then try to reinstall `Node.js`.
 
-5. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH).
+5. Make sure you have `MySQL` installed on your machine. Click [here](https://dev.mysql.com/downloads/mysql/) to download and install MySQL. Make sure you install the latest version.
 
-```bash
-git clone git@github.com:techstartucalgary/fashion.git
-```
-
-6. `cd` into the `backend` directory.
-
-```bash
-cd backend
-```
-
-7. Run `npm install --only=production` to install all the dependencies.
+6. Open the terminal and run `mysql --version` to check if `MySQL` is installed.
 
 ```bash
-npm install --only=production
+mysql --version
 ```
 
-8. Run `npm run start` to start the server.
+7. If you see the version number of `MySQL` then you are good to go. If not, then try to reinstall `MySQL`.
 
-```bash
-npm run start
-```
+8. Make sure you have `Redis` installed on your machine. Click [here](https://redis.io/download) to download and install Redis. Make sure you install the latest version.
 
-9. Open the browser and go to `http://localhost:8080/` to see the server running.
+9. Open the terminal and run `redis-server --version` to check if `Redis` is installed.
 
 ```bash
-http://localhost:8080/
+redis-server --version
 ```
 
-### 🐳 Quickstart with Docker
+10. If you see the version number of `Redis` then you are good to go. If not, then try to reinstall `Redis`.
 
-1. Make sure you have `Docker` installed on your machine. Click [here](https://docs.docker.com/get-docker/) to download and install Docker.
-
-2. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH).
+11. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH).
 
 ```bash
 git clone git@github.com:techstartucalgary/fashion.git
 ```
 
-3. `cd` into the `backend` directory.
+12. `cd` into the `backend` directory.
 
 ```bash
 cd backend
 ```
 
-4. Run `docker-compose up` to start the server.
+13. Run `npm install --only=production` to install all the dependencies.
 
 ```bash
-docker-compose -f docker-compose.prod.yml up -d
+npm install
 ```
 
-5. Open the browser and go to `http://localhost:8080/` to see the server running.
+14. Run `npm run start` to start the server.
 
 ```bash
-http://localhost:8080/
-```
-
-### ❤️ Health check
-
-To check if the backend is running, open the browser and go to `http://localhost:8080/api/v1/health`. You should see the following message.
-
-```bash
-{"status":"healthy"}
+npm run start
 ```
 
 ### 🚧 Development Environment
 
-Using Docker (Recommended)
-
-1. Make sure you have `Docker` installed on your machine. Click [here](https://docs.docker.com/get-docker/) to download and install Docker.
+1. Make sure you have `Node.js` and `NPM` installed on your machine. Click [here](https://nodejs.org/en/) to download and install Node.js. Make sure you install the LTS version. NPM is installed automatically when you install Node.js.
 
-2. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH).
+2. Open the terminal and run `node -v` to check if `Node.js` is installed.
 
 ```bash
-git clone git@github.com:techstartucalgary/fashion.git
+node -v
 ```
 
-3. `cd` into the `backend` directory.
+3. In the same terminal run `npm -v` to check if `npm` is installed.
 
 ```bash
-cd backend
+npm -v
 ```
 
-4. Run `docker-compose up` to start the server.
+4. If you see the version number of `Node.js` and `npm` then you are good to go. If not, then try to reinstall `Node.js`.
 
-```bash
-docker-compose -f docker-compose.dev.yml up -d
-```
+5. Make sure you have `MySQL` installed on your machine. Click [here](https://dev.mysql.com/downloads/mysql/) to download and install MySQL. Make sure you install the latest version.
 
-5. Open the browser and go to `http://localhost:8080/` to see the server running.
+6. Open the terminal and run `mysql --version` to check if `MySQL` is installed.
 
 ```bash
-http://localhost:8080/
+mysql --version
 ```
 
-Using Node.js
+7. If you see the version number of `MySQL` then you are good to go. If not, then try to reinstall `MySQL`.
 
-1. Make sure you have `Node.js` and `NPM` installed on your machine. Click [here](https://nodejs.org/en/) to download and install Node.js. Make sure you install the LTS version. NPM is installed automatically when you install Node.js.
+8. Make sure you have `Redis` installed on your machine. Click [here](https://redis.io/download) to download and install Redis. Make sure you install the latest version.
 
-2. Open the terminal and run `node -v` to check if `Node.js` is installed.
+9. Open the terminal and run `redis-server --version` to check if `Redis` is installed.
 
 ```bash
-node -v
+redis-server --version
 ```
 
-3. In the same terminal run `npm -v` to check if `npm` is installed.
+10. If you see the version number of `Redis` then you are good to go. If not, then try to reinstall `Redis`.
 
-```bash
-npm -v
-```
-
-4. If you see the version number of `Node.js` and `npm` then you are good to go. If not, then try to reinstall `Node.js`.
-
-5. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH).
+11. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH).
 
 ```bash
 git clone git@github.com:techstartucalgary/fashion.git
 ```
 
-6. `cd` into the `backend` directory.
+12. `cd` into the `backend` directory.
 
 ```bash
 cd backend
 ```
 
-7. Run `npm install` to install all the dependencies.
+13. Run `npm install` to install all the dependencies.
 
 ```bash
 npm install
 ```
 
-8. Run `npm run start` to start the server.
+14. Run `npm run start` to start the server.
 
 ```bash
 npm run dev
 ```
 
-9. Open the browser and go to `http://localhost:8080/` to see the server running.
-
-```bash
-http://localhost:8080/
-```
-
-Environment Variables
-
-The environment variables must be located in the `backend/.env` file (If not such file exists, create one). The following environment variables are required to run the server.
+15. Run `npx prisma studio` to open Prisma Studio and view the database schema (Optional).
 
 ```bash
-PORT=<port number>
+npx prisma studio
 ```
 
 ### 🧪 Testing

backend/package.json

@@ -6,16 +6,18 @@
   "type": "module",
   "scripts": {
     "build": "npx tsc",
-    "prestart": "npm run build",
+    "prestart": "npx prisma migrate deploy && npx prisma generate",
     "start": "NODE_ENV=PROD node dist/src/index.js",
+    "predev": "npx prisma migrate dev --name init && npx prisma generate",
     "dev": "NODE_ENV=DEV nodemon -e ts --exec \"npm run build && node dist/src/index.js\"",
-    "pretest": "npm run build",
-    "test": "NODE_ENV=TEST mocha dist/test/**/*.test.js"
+    "pretest": "npx prisma migrate deploy && npx prisma generate",
+    "test": "NODE_ENV=TEST npm run build && mocha \"dist/test/**/*.test.js\""
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@prisma/client": "^5.6.0",
     "cors": "^2.8.5",
     "dotenv": "^16.3.1",
     "express": "^4.18.2"
@@ -30,6 +32,7 @@
     "chai": "^4.3.10",
     "mocha": "^10.2.0",
     "nodemon": "^3.0.1",
+    "prisma": "^5.6.0",
     "supertest": "^6.3.3",
     "typescript": "^5.2.2"
   },