diff --git a/README.md b/README.md index 40773fb..cfcc9e6 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,89 @@ # โ™ป๏ธ Fashion -## ๐Ÿš€ Backend Documentation +## ๐Ÿ“– Table of Contents -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/). +- [๐Ÿ“ Contributors](#-contributors) +- [๐Ÿ‘จโ€๐Ÿ’ป Teck Stack](#-teck-stack) +- [๐Ÿš€ Backend Documentation](#-backend-documentation) + - [๐Ÿƒ Quickstart](#-quickstart) + - [๐Ÿ› ๏ธ Installation](#๏ธ-installation) + - [๐Ÿงช Testing](#-testing) + - [๐Ÿšง Development Environment](#-development-environment) -### ๐Ÿƒ Quickstart +## ๐Ÿ“ Contributors -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. +- [Lujaina]() - Project Manager +- [Parsa]() - Frontend Developer +- [Morteza]() - Frontend Developer +- [Axel Sanchez](https://github.com/Axeloooo) - Backend Developer +- [Anfaal]() - Backend Developer +- [Ryan]() - Backend Developer +- [Alison]() - Backend Developer -2. Open the terminal and run `node -v` to check if `Node.js` is installed. +## ๐Ÿ‘จโ€๐Ÿ’ป Teck Stack -```bash -node -v -``` +- Frontend -3. In the same terminal run `npm -v` to check if `npm` is installed. + ![Swift](https://img.shields.io/badge/Swift-F05138.svg?style=for-the-badge&logo=Swift&logoColor=white) + ![Xcode](https://img.shields.io/badge/Xcode-1575F9.svg?style=for-the-badge&logo=Xcode&logoColor=white) + ![Figma](https://img.shields.io/badge/Figma-F24E1E.svg?style=for-the-badge&logo=Figma&logoColor=white) -```bash -npm -v -``` +- Backend -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`. + ![Typescript](https://img.shields.io/badge/TypeScript-3178C6.svg?style=for-the-badge&logo=TypeScript&logoColor=white) + ![Node.js](https://img.shields.io/badge/Node.js-339933.svg?style=for-the-badge&logo=nodedotjs&logoColor=white) + ![Express](https://img.shields.io/badge/Express-000000.svg?style=for-the-badge&logo=Express&logoColor=white) + ![OpenAI](https://img.shields.io/badge/OpenAI-412991.svg?style=for-the-badge&logo=OpenAI&logoColor=white) + ![Prisma](https://img.shields.io/badge/Prisma-2D3748.svg?style=for-the-badge&logo=Prisma&logoColor=white) + ![MySQL](https://img.shields.io/badge/MySQL-4479A1.svg?style=for-the-badge&logo=MySQL&logoColor=white) + ![Redis](https://img.shields.io/badge/Redis-DC382D.svg?style=for-the-badge&logo=Redis&logoColor=white) -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. +- Testing -6. Open the terminal and run `mysql --version` to check if `MySQL` is installed. + ![Mocha](https://img.shields.io/badge/Mocha-8D6748.svg?style=for-the-badge&logo=Mocha&logoColor=white) + ![Chai](https://img.shields.io/badge/Chai-A30701.svg?style=for-the-badge&logo=Chai&logoColor=white) -```bash -mysql --version -``` +- CI/CD -7. If you see the version number of `MySQL` then you are good to go. If not, then try to reinstall `MySQL`. + ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=for-the-badge&logo=GitHub%20Actions&logoColor=white) -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. +## ๐Ÿš€ Backend Documentation -9. Open the terminal and run `redis-server --version` to check if `Redis` is installed. +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 + +1. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH). ```bash -redis-server --version +git clone git@github.com:techstartucalgary/fashion.git ``` -10. If you see the version number of `Redis` then you are good to go. If not, then try to reinstall `Redis`. - -11. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH). +2. `cd` into the `fashion` directory. ```bash -git clone git@github.com:techstartucalgary/fashion.git +cd fashion ``` -12. `cd` into the `backend` directory. +3. `cd` into the `backend` directory. ```bash cd backend ``` -13. Run `npm install --only=production` to install all the dependencies. +4. Run `npm install --only=production` to install all the dependencies. ```bash npm install ``` -14. Run `npm run start` to start the server. +5. Run `npm run start` to start the server. ```bash npm run start ``` -### ๐Ÿšง Development Environment +### ๐Ÿ› ๏ธ Installation 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. @@ -104,60 +121,68 @@ redis-server --version 10. If you see the version number of `Redis` then you are good to go. If not, then try to reinstall `Redis`. -11. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH). +### ๐Ÿงช Testing + +All the tests are located in the `backend/test` directory. The tests suites are written using [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/). + +1. 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 ``` -12. `cd` into the `backend` directory. +2. `cd` into the `backend` directory. ```bash cd backend ``` -13. Run `npm install` to install all the dependencies. +3. Run `npm install` to install all the dependencies. ```bash npm install ``` -14. Run `npm run start` to start the server. +4. Run `npm run test` to start the server. ```bash -npm run dev +npm run test ``` -15. Run `npx prisma studio` to open Prisma Studio and view the database schema (Optional). +### ๐Ÿšง Development Environment + +1. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH). ```bash -npx prisma studio +git clone git@github.com:techstartucalgary/fashion.git ``` -### ๐Ÿงช Testing - -All the tests are located in the `backend/test` directory. The tests suites are written using [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/). - -1. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH). +2. `cd` into the `fashion` directory. ```bash -git clone git@github.com:techstartucalgary/fashion.git +cd fashion ``` -2. `cd` into the `backend` directory. +3. `cd` into the `backend` directory. ```bash cd backend ``` -3. Run `npm install` to install all the dependencies. +4. Run `npm install` to install all the dependencies. ```bash npm install ``` -4. Run `npm run test` to start the server. +5. Run `npm run start` to start the server. ```bash -npm run test +npm run dev +``` + +6. Run `npx prisma studio` to open Prisma Studio and view the database schema (Optional). + +```bash +npx prisma studio ```