https://github.com/obrm/shops-api

This repository contains the source code for the SHPOS API. It's built using Node.js, Express.js, and MongoDB.
https://github.com/obrm/shops-api

colors dotenv express mongodb mongoose morgan nodejs nodemon slugify

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/obrm/shops-api
• Owner: obrm
• Created: 2023-03-20T06:48:33.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-26T10:26:55.000Z (almost 2 years ago)
• Last Synced: 2024-07-29T17:58:30.171Z (6 months ago)
• Topics: colors, dotenv, express, mongodb, mongoose, morgan, nodejs, nodemon, slugify
• Language: JavaScript
• Homepage:
• Size: 50.8 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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:

```bash

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](#local-environment-variables) section in this README for more information.

## Installation

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

```bash

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:

```env

NODE_ENV=development

PORT=5000

MONGO_URI=

```

Make sure to replace `` with the actual URI for your MongoDB instance.

## Running the Project

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

```bash

npm run dev

```

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

## License

This project is licensed under the MIT License.