Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sourabh250/subscribers-mongo-node-main

A simple API built with Node.js and Express that lets you manage and fetch subscriber details from a MongoDB database. It has endpoints to get all subscribers, just their names, or details for a specific subscriber by ID.
https://github.com/sourabh250/subscribers-mongo-node-main

backend chai express mocha mongodb mongoose nodejs rest-api swagger

Last synced: 11 days ago
JSON representation

Host: GitHub
URL: https://github.com/sourabh250/subscribers-mongo-node-main
Owner: Sourabh250
License: mit
Created: 2024-08-16T16:36:25.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-08-17T11:28:42.000Z (5 months ago)
Last Synced: 2024-12-25T18:41:37.414Z (11 days ago)
Topics: backend, chai, express, mocha, mongodb, mongoose, nodejs, rest-api, swagger
Language: JavaScript
Homepage: https://subscribers-mongo-node-main.onrender.com/
Size: 40 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Subscribers-Mongo-Node-main

A simple but powerful API built with Node.js and Express that allows you to manage and fetch subscriber details from a MongoDB database. It provides endpoints to retrieve all subscribers, obtain subscriber names, or access details for a specific subscriber by their ID.

## Table of Contents

1. [Technologies/Languages Used](#technologieslanguages-used)

2. [Installation and Setup](#installation-and-setup)

3. [Usage](#usage)

4. [API Endpoints](#api-endpoints)

5. [Testing](#testing)

6. [Deployment](#deployment)

7. [Live API Documentation](#live-api-documentation)

8. [Contributing](#contributing)

9. [Author](#author)

10. [License](#license)

## Technologies/Languages Used

| ![Node.js Logo](https://img.shields.io/badge/Node.js-%E2%9C%94-brightgreen) | ![Express](https://img.shields.io/badge/Express-%E2%9C%94-blue) | ![MongoDB](https://img.shields.io/badge/MongoDB-%E2%9C%94-green) | ![Mocha](https://img.shields.io/badge/Mocha-%E2%9C%94-yellowgreen) | ![Chai](https://img.shields.io/badge/Chai-%E2%9C%94-red) | ![Swagger](https://img.shields.io/badge/Swagger-%E2%9C%94-blueviolet) |

|:--:|:--:|:--:|:--:|:--:|:--:|

- **Node.js** - JavaScript runtime used for building the server-side application.

- **Express** - Web application framework for Node.js, used to build the API.

- **MongoDB** - NoSQL database used for storing subscriber data.

- **Mongoose** - MongoDB object modeling tool for Node.js.

- **Mocha** - Test framework used for running tests.

- **Chai** - Assertion library used in conjunction with Mocha for testing.

- **Swagger UI** - Tool for API documentation and testing.

## Installation and Setup

1. Clone the repository:

    ```bash

    git clone https://github.com/Sourabh250/Subscribers-Mongo-Node-main.git

    ```

2. Install dependencies:

    ```bash

    npm install

    ```

3. Create a `.env` file at the root and add the following:

To run this project, you will need to add the following environment variables to your .env file

`DATABASE_URL` & `PORT`.  

You can use the provided .env.example file as a reference.

    ```

    DATABASE_URL=your_database_connection_string

    PORT=3000

    ```

## Usage

To start the server, run:

```bash

npm start

```

This will start the Express server at http://localhost:3000.

## API Endpoints

Get all subscribers

```

GET /subscribers

```

| Parameter | Type     | Description                |

| :-------- | :------- | :------------------------- |

| `None` | `None` | Retrieves a list of all subscribers. |

Get subscriber names

```

GET /subscribers/names

```

| Parameter | Type     | Description                |

| :-------- | :------- | :------------------------- |

| `None` | `None` | Retrieves a list of subscribers with name and subscribed channel. |

Get specific subscriber by ID

```

GET /subscribers/:id

```

| Parameter | Type     | Description                |

| :-------- | :------- | :------------------------- |

| `id` | `string` | **Required**. ID of the subscriber to fetch. |

## Testing

To run the tests, make sure you have Mocha and Chai installed. Then, run the following command:

```

npm test

```

The tests will execute using Mocha and Chai. Test results will be generated and saved in the mochawesome-report folder

## Deployment

For deployment, follow these steps:

#### 1. Prepare your environment:

Ensure that environment variables are set and the database is accessible.

#### 2. Deploy to your preferred hosting service:

For example, you can use platforms like Heroku, AWS, or Render.

#### 3. Set up deployment scripts if necessary:

Configure deployment settings according to your hosting provider's guidelines.

[**Render Link**](https://subscribers-mongo-node-main.onrender.com/)

## Live API Documentation

Explore the API documentation and interact with the endpoints via Swagger UI:

- **Local Environment**: [Explore the API documentation](http://localhost:3000/api-docs)

- **Production**: [Explore the API documentation](https://subscribers-mongo-node-main.onrender.com/api-docs/)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## Author

- [@Sourabh](https://github.com/Sourabh250) - Developer and maintainer of this project.

## License

This project is licensed under the MIT License - see the LICENSE.md file for details.

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)