https://github.com/temitopeakin1/products-api

A product API used to manage varieties of product in a store, user authentication, access tokens
https://github.com/temitopeakin1/products-api

docker mongodb mongodb-atlas mongoose nodejs typescript

Last synced: 5 days ago
JSON representation

A product API used to manage varieties of product in a store, user authentication, access tokens

• Host: GitHub
• URL: https://github.com/temitopeakin1/products-api
• Owner: temitopeakin1
• Created: 2024-03-25T21:56:45.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-23T14:54:16.000Z (3 months ago)
• Last Synced: 2024-08-23T16:33:53.342Z (3 months ago)
• Topics: docker, mongodb, mongodb-atlas, mongoose, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 242 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Product Store API


## Table of Contents

- [Description](#description)

- [Setup](#setup)

- [Technologies](#technologies)

- [Usage](#usage)

- [Contributing](#contributing)

---

Description

This is a Product Store API that allows a User to Register, Log in and access Products, create products, update and get products


## Setup

1. Clone the repository...

2. Install dependencies...

3. Run the setup script...

## Technologies

Make sure the following is installed

NodeJs

TypeScript

Bcrypt

JWT

Mongoose

Docker


Once Repo is cloned and the required software installed, Navigate to the root of the project and run the following command

```bash

docker-compose -f docker-compose.yml build

docker-compose up -d --build

```

These will build the docker image and run the API on your local machine.

To access the API, navigate to http://localhost:3000/ in your browser.

Usage

To use the API, all the endpoints are available on the API Documentation Page 


The API documentation provides a list of all the endpoints available and the required parameters for each endpoint.


Contributing

To contribute to the project, fork the repository and create a pull request. Make sure to provide a detailed description of the changes you made and the reason for the changes. All contributions are welcome. Frontend developers who have built online products applications are encouraged to use the API and provide feedback on how it can be improved. 

PLEASE DO NOT PUSH TO THE MAIN BRANCH. Create a new branch and create a new pull request from that branch to the main.