FileHive-API

Description

This is a sophisticated file management app. You can easily upload, update, edit, delete, comment, and share your files.

Features

• Feature 1: Role-based user authentication
• Feature 2: Create, update, edit, delete folders and files. You can also create nested folders
• Feature 3: One can place comments and annotations for a file

FileHive necessary files and file links

The following documents outline the key requirements and design considerations for FileHive:

Project Requirements:

• Project Requirements: Download here
• Developer-Friendly Requirements: Download here

Documentation:

• Raff Documentation: Download here
• Swagger Documentation: View API documentation

Development:

• Database Schema and Design: Download here
• API Folder Structure: Download here

Technologies Used

• Node.js
• Express.js
• MongoDB
• JWT for authentication
• Swagger for API documentation
• Jest for testing
• Other relevant technologies

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js (v18 or above)
• npm (v8 or above) or Yarn
• MongoDB

Installation

1. Clone the repository:

   git clone https://github.com/nasimhelal-cell/file-hive-api.git

2. Navigate to the project directory:

   cd file-hive-api

3. Install the dependencies:

   npm install

Configuration

1. Create a .env file in the root directory and add the following environment variables:

   PORT=4000
   DB_URL=mongodb://localhost:27017/filehive
   JWT_SECRET=secret
   

2. Modify other configurations as necessary.

Running the Application

Development

To run the application in development mode:

npm start