-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16 from techstartucalgary/docs/improve-documentation
docs: Contributors, tech stack and installation articles implemented
- Loading branch information
Showing
1 changed file
with
72 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ```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`. | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| 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. | ||
|  | ||
|  | ||
|
|
||
| ```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`. | ||
|  | ||
|
|
||
| 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 [email protected]: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 [email protected]: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 [email protected]: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 [email protected]: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 [email protected]: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 | ||
| ``` | ||