Skip to content

πŸ—‚οΈ This is the backend of the InfoReader project. It is a REST API that is used to store and retrieve data from the database

License

Notifications You must be signed in to change notification settings

marcode24/inforeader-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“° InfoReader API

Version GitHub CI Workflow Status GitHub repo size GitHub GitHub Repo stars Github repo views GitHub last commit

πŸš€ 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
  • NPM
  • Git
  • MongoDB

Optional tools:

  • Visual Studio Code
  • Postman
  • MongoDB Compass

πŸ“¦ Installation & Usage

# 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 file for details. πŸ˜‰

About

πŸ—‚οΈ This is the backend of the InfoReader project. It is a REST API that is used to store and retrieve data from the database

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published