Circuit City: Electrical Equipment E-Commerce API

Table of Contents

1. Introduction
2. Technologies Used
3. Project Structure
4. Installation
5. Usage
6. Contributing
7. Licensing

Introduction

Circuit City is an online market for the distribution of everything electrical, from hand tools to large machinery, circuit city aims to provide a comprehensive marketplace for professionals, resellers and consumers in the electrical industry.

API Documentation

You can read the full API documentation at link.

The Team

• Olayinkascott Andee
  • Role: Developer
  • Andee's LinkedIn

💻 Technologies Used

Project Structure

• /controllers: These are functions that generate response to requests .
• /middlewares: These intercept requests before it gets to the controller.
• /models: Data declaration for each of the resources.
• /routes: These contains the available routes for each resource.
• /tests: Unittests for functions.
• package.json: This file contains the project's metadata.
• server.js: This is the entry point into the application.

Installation

Prerequisites

• Create a Mongodb Atlas account at link. Afterwards, create a new database with the name CircuitCity
• Create a cloudinary account at link

Installation Steps

1. Clone the Repository.

   git clone [email protected]:scottandee/circuit_city.git

2. Run npm install

   npm install

3. create a .env file and fill it with the data below:

   # Environment Variables
   PORT=5000
   
   # DB Config
   DB_USERNAME='value'
   DB_PASSWORD='value'
   
   # Bcrypt salt
   SALT=value
   
   # JWT Secret Key
   JWT_SECRET_KEY=secret key value
   
   # Cloudinary
   CLOUDINARY_CLOUD_NAME=''
   CLOUDINARY_API_KEY=''
   CLOUDINARY_API_SECRET=''

   Note: value is only a placeholder and should be substituted with the actual values.

5. run npm server.js.

Contributing

Here are some steps to follow when contributing to this project:

1. Fork the repository
2. Clone the repository into your machine
3. Install all dependencies with npm install
4. Make your changes
5. Write tests for your changes and make sure they pass
6. Commit your changes
7. Push your changes to your fork
8. Create a pull request to the original repository

Licensing

This project is licensed under the MIT License.

Copyright (c) 2024 Olayinkascott Andee.

See the LICENSE file for more information.