Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/harkiratsm/wheels-server

REST API served to wheels
https://github.com/harkiratsm/wheels-server

docker expressjs mongoose nginx nodejs

Last synced: 6 days ago
JSON representation

REST API served to wheels

Awesome Lists containing this project

README

        

![food-server](https://socialify.git.ci/harkiratsm/food-server/image?description=1&language=1&name=1&owner=1&pattern=Brick%20Wall&theme=Light)















## 💥 Introduction

I have developed a REST API that I am going to serve for frontend i.e. food-client. At the moment, this API can handle restaurant, order, and image requests.

I built a REST API with Express.js, using MongoDB as a database to store the data, containerized my Nodejs app with Docker, and also used Nginx to load balance API requests.

### Table of Contents

- [Tech Stack](#tech-stack)
- [Installation Steps](#install-step)
- [Built With](#built-with)
- [Requirements](#requires)

## ⚙️ Tech Stack

The technologies I used to built this app.

- Nodejs
- Expressjs

## 🛠️ Installation Steps

1. Clone the repository

```bash
git clone https://github.com/harkiratsm/food-server.git
```

2. Change the working directory

```bash
cd food-server
```
3. For Development Environment
- Install dependencies

```bash
make server-setup
```
- Make sure you set all the environment variables under ```.env``` file.

- Run the docker-compose file

```bash
make docker-compose_dev
```

4. For Production [here](https://github.com/harkiratsm/food-server/blob/main/LEARNING.md#prod).

🚀 You are all set to go.

## 💻 Built With

1. Expressjs - Rest API
2. MongoDB - Database
3. Nodejs
4. Docker
5. Nginx - Load balancing api calls

## 🙋🏻‍♂️ Requirements

1. Docker Desktop
2. Nodejs
3. MongoDB
4. Postman - For testing api endpoints

## 📖 [License](https://github.com/harkiratsm/food-server/blob/main/License)