https://github.com/marcode24/inforeader-backend

🗂️ This is the backend of the InfoReader project. It is a REST API that is used to store and retrieve data from the database
https://github.com/marcode24/inforeader-backend

api docker-compose express husky javascript lint-staged mongodb mongoose nodejs

Last synced: 6 months ago
JSON representation

🗂️ This is the backend of the InfoReader project. It is a REST API that is used to store and retrieve data from the database

• Host: GitHub
• URL: https://github.com/marcode24/inforeader-backend
• Owner: marcode24
• License: mit
• Created: 2022-07-01T20:16:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-07T05:51:09.000Z (about 1 year ago)
• Last Synced: 2025-02-04T00:32:31.967Z (10 months ago)
• Topics: api, docker-compose, express, husky, javascript, lint-staged, mongodb, mongoose, nodejs
• Language: JavaScript
• Homepage: https://info-reader-backend.vercel.app/
• Size: 483 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  
 📰 InfoReader API 


  ![Version](https://img.shields.io/github/package-json/v/marcode24/inforeader-backend?style=popout&logo=npm)

  ![GitHub CI Workflow Status](https://img.shields.io/github/actions/workflow/status/marcode24/inforeader-backend/ci.yml?branch=main&style=popout&logo=testcafe&label=linter)

  ![GitHub repo size](https://img.shields.io/github/repo-size/marcode24/inforeader-backend?style=popout&logo=github&label=repo%20size)

  ![GitHub](https://img.shields.io/github/license/marcode24/inforeader-backend?style=popout&logo=github&label=license)

  ![GitHub Repo stars](https://img.shields.io/github/stars/marcode24/inforeader-backend?style=popout&logo=apachespark&color=yellow&logoColor=yellow)

  ![Github repo views](https://img.shields.io/github/search/marcode24/inforeader-backend/inforeader-backend?style=popout&logo=github&label=repo%20views)

  ![GitHub last commit](https://img.shields.io/github/last-commit/marcode24/inforeader-backend?style=popout&logo=git&label=last%20commit)



## 🚀 Getting Started

This is the backend of the InfoReader project. It is a REST API that is used to manage the data of the InfoReader project.

### 📝 Requirements

- [![Node](https://img.shields.io/badge/Node-gray?style=popout&logo=node.js)](https://nodejs.org/en/)

- [![NPM](https://img.shields.io/badge/NPM-blue?style=popout&logo=npm)](https://www.npmjs.com/)

- [![Git](https://img.shields.io/badge/Git-gray?style=popout&logo=git)](https://git-scm.com/)

- [![MongoDB](https://img.shields.io/badge/MongoDB-green?style=popout&logo=mongodb)](https://www.mongodb.com/)

Optional tools:

- [![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-blue?style=popout&logo=visual-studio-code)](https://code.visualstudio.com/)

- [![Postman](https://img.shields.io/badge/Postman-black?style=popout&logo=postman)](https://www.postman.com/)

- [![MongoDB Compass](https://img.shields.io/badge/MongoDB%20Compass-green?style=popout&logo=mongodb)](https://www.mongodb.com/products/compass)

### 📦 Installation & Usage

```bash

# Clone the repository

$ git clone https://github.com/marcode24/inforeader-backend

# Go inside the directory

$ cd inforeader-backend

# Install dependencies

$ npm install

# Start the server

$ npm run start

```

### 📝 Environment Variables

To run this project, you will need to add the following environment variables to your `.env` file in the root of the project:

- `PORT` - The port number where the server will run

- `MONGO_URL` - The URI of the MongoDB database

- `JWT_SECRET` - The secret key used to sign the JWT tokens for authentication and authorization purposes

## 📝 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. 😉