Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 2.98 KB

README.md

File metadata and controls

58 lines (41 loc) · 2.98 KB

☁️ Cloud Box 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 for the Cloud Box project. It is a REST API that is used to manage the cloud box.

📝 Requirements

  • Node
  • NPM
  • Git
  • MongoDB
  • Azure Storage Account

Optional tools:

  • Visual Studio Code
  • Postman
  • MongoDB Compass

📦 Installation & Usage

# Clone this repository
$ git clone https://github.com/marcode24/cloudbox-backend

# Go into the repository
$ cd cloudbox-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
  • AZURE_STORAGE_CONNECTION_STRING - The connection string of the Azure Storage Account used to store the files uploaded by the users

📝 License

This project is licensed under the MIT License. See the LICENSE file for details. 😉