File Sharing Backend

A very simple file sharing backend running on Node.js and Express.js.

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.

Prerequisites

The project runs on Node.js

• Download Node.js

Installing

Clone this repository

git clone https://github.com/Hathoute/file-sharing-backend

Switch to project directory

cd file-sharing-backend

Run npm install to download dependencies

npm install

Before continuing, please configure your environment (port, database, ...) by following Configuring the environment.

Create the database (Attention: this will alter any database with the same name as the one specified in the config)

npm run db-initialize

Start the backend

npm start

Configuring the environment

You can easily configure the backend without having to alter any javascript file.

Locate config/default.json and adapt it to whatever you need.

API

You can view the API here

Built With

• Express.js
• WebStorm IDE
• OpenAPI 3.0 - Used to create a documentation for the API

License

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