Welcome to the GitHub repository for FileFerry, a web-based file sharing platform built with MongoDB.

Developers:

• Dias Mustafin (@dmustafinnn)
• Sasanka Kosuru (@ksasanka11)
• Anahita Dinesh (@anahita20)

API Documentation: https://documenter.getpostman.com/view/9930451/2s93XyUiBq

1. Make sure you have Docker Desktop installed on your computer.
2. For the first time, install the packages.

   // from project root
   cd ./client
   npm install
   
   // from project root
   cd ./server
   npm install
   

3. Create a .env file in the server directory and enter the following variables.

   ATLAS_DB=                   // link to the mongodb atlas cluster
   JWT_SECRET=
   

4. From the project root directory, run the following command to build the Docker containers:

   docker-compose build
   

5. After the build is complete, start the Docker containers by running the following command:

   docker-compose up
   

6. The following table shows the ports used by each container:

   Service	Container Name	Port
   Frontend	fileferry-client	3000
   Backend	fileferry-server	5000
   Database	fileferry-db	27017

Once you have the project set up and running, you can access the FileFerry application by navigating to http://localhost:3000 in your web browser. From there, you can use the platform to upload, download, and share files with others.

• Upload files
• Share files with other registered users
• Authorization to accept shared files
• Create a whitelist (users from whom a user can receive files without authorization)
• Download files owned and shared to a user
• Delete the files owned by a user
• View the users who have access to your file
• Revoke access to a file

• Rename your files
• View and update user's profile