obrm / shops-api

This repository contains the source code for the SHPOS API. It's built using Node.js, Express.js, and MongoDB.

SHOPS API

This repository contains the source code for the Sops API. It's built using Node.js, Express.js, and MongoDB.

Getting Started

To get started with this project, clone the repository:

git clone https://github.com/obrm/shpos-api.git

Prerequisites

Make sure you have Node.js installed on your system.

MongoDB Atlas

To run this project, you'll also need to have a MongoDB Atlas account and create a project for this project in MongoDB Atlas. Once you have created a project in MongoDB Atlas, you can obtain your MongoDB URI, which you will need to set as an environment variable in the config.env file to connect to your database. See the Local Environment Variables section in this README for more information.

Installation

After cloning the repository, run the following command to install the required dependencies:

npm install

Local Environment Variables

In order to run the project locally, you'll need to set some environment variables. Create a config folder in the root directory of the project, and add a file named config.env with the following variables:

NODE_ENV=development
PORT=5000
MONGO_URI=<Your MongoDB URI>

Make sure to replace <Your MongoDB URI> with the actual URI for your MongoDB instance.

Running the Project

To start the server in development mode with nodemon, run the following command:

npm run dev

The server should now be running on http://localhost:5000.

License

This project is licensed under the MIT License.