-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
108 additions
and
2 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 |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2020 Ileriayo Adebiyi | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
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,2 +1,87 @@ | ||
| # e-commerce-crafters-bn | ||
| Crafter's backend repo | ||
|
|
||
| # e-commerce-crafters-bn :muscle: | ||
| This repository contains the backend application of an e-commerce website developed by Andela Team Crafters | ||
| [](https://github.com) | ||
|
|
||
| - Table of content | ||
| - [Project Overview](#project-overview) | ||
| - [Technology used](#technology-used) | ||
| - [Using the project](#using-the-project) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Installation](#installation) | ||
| - [Contribution](#contribution) | ||
| - [Documentation](#documentation) | ||
| - [Deployed\_link:](#deployed_link) | ||
| - [Licensing](#licensing) | ||
| ### 1. Project Overview | ||
|
|
||
| In our project we developed an ecommerce application which is a platform where buyers and sellers meet to interact. Each Seller will be able to register, post their products, and fully manage their stock. Buyers will be able to see all the products on the platform, add and remove products to their shopping carts, and buy from any seller where they will be able to pay via the platform. | ||
|
|
||
| ### 2. Technology used | ||
|
|
||
| * Node.js:  | ||
|
|
||
| * Express:  | ||
|
|
||
| * Postgres Database: [](https://www.postgresql.org/) | ||
|
|
||
| * Sequelize ORM: [](https://sequelize.org/) | ||
|
|
||
| * Testing by Jest:[](https://jestjs.io/) | ||
|
|
||
|
|
||
| ## 3.Using the project | ||
|
|
||
| For those who are interested to use it locally,he/she is required the following: | ||
|
|
||
| ### * Prerequisites | ||
|
|
||
| - Node.js | ||
| - Packages | ||
| - Postgres database | ||
| - Git | ||
|
|
||
| ### *Installation | ||
|
|
||
| 1. Clone the repository from github https://github.com/atlp-rwanda/e-commerce-crafters-bn.git | ||
| 2. Run `npm install` to install all package dependencies | ||
| 3. Copy the environment configuration: | ||
| `cp .env.example .env` | ||
| you can update the values of .env file with yours. | ||
| 3. To run migrations into Postgres use the following command: | ||
| `npx sequelize-cli db:migrate` | ||
| `sequelize-cli`: This refers to the Sequelize Command Line Interface (CLI), which provides commands for interacting with Sequelize, including creating migrations, models, seeders, and running migrations. | ||
| 4. To run seeders into Postgres use the following command: | ||
| `npx sequelize-cli db:seed:all` | ||
| 5. Run the project using this command `npm start` | ||
| 6. running test by `npm test` | ||
|
|
||
| ## 4.Contribution | ||
|
|
||
| To contribute to this project: | ||
|
|
||
| 1. Clone the repository | ||
| 2. Create your own branch to avoid direct pushing to main brach without creating pullrequest and get reviewed. | ||
|
|
||
| - feature(ft): `git checkout -b ft-name-of-the-feature-bn-TrelloId` | ||
| - chore(ch): `git checkout -b ch-name-of-the-chore-bn-TrelloId ` | ||
| - bug(bd): `git checkout -b bg-name-of-the-bug-bn-TrelloId ` | ||
|
|
||
|
|
||
| 1. Then you can commit any changes you made by: `git commit -m "your commit message"` | ||
| 2. Push your changes to the branch you created `git push origin your-new-branch-name` | ||
| 3. create a pull request and wait for review from other collabolators | ||
| ### 5.Documentation | ||
|  | ||
| The following are steps to create your api documentation: | ||
| - Navigate to the location `src/docs`. | ||
| Create a `.yaml` file. | ||
| - Write your documentation in the file. | ||
| No need to set up Swagger-related things in `server.ts` again. <br>:warning: | ||
| You must know that YAML strictly follows indentation | ||
| ### Deployed_link:https://e-commerce-crafters-bn.onrender.com/ | ||
| ## 6.Licensing | ||
| [](https://github.com/Naereen/StrapDown.js/blob/master/LICENSE) | ||
| This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for detail. | ||
|
|
||
|
|