Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harshitrv/fileshare
This web app, also an API lets users upload files and generates a link to share them. The generated links can be password protected.
https://github.com/harshitrv/fileshare
ejs express javascript mongodb mongoose nodejs
Last synced: about 2 months ago
JSON representation
This web app, also an API lets users upload files and generates a link to share them. The generated links can be password protected.
- Host: GitHub
- URL: https://github.com/harshitrv/fileshare
- Owner: HarshitRV
- License: mit
- Created: 2022-06-29T08:55:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T09:37:55.000Z (5 months ago)
- Last Synced: 2024-07-30T05:37:09.915Z (5 months ago)
- Topics: ejs, express, javascript, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage: https://rapidshare.netlify.app
- Size: 16 MB
- Stars: 8
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: docs/code-of-conduct.md
Awesome Lists containing this project
README
# FileShare App 
This NodeJS app let't you upload files and generate a link to download them.
The generated links can be password protected as well.
# Setting up the app locally.
## Prerequisites
- NodeJS v16.x
- MongoDB v5.x [Windows](https://medium.com/@LondonAppBrewery/how-to-download-install-mongodb-on-windows-4ee4b3493514) | [Mac](https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-os-x/)
- MongoDB Compass(optional)
- [tinyurl.com](https://tinyurl.com/) API key for shortening url links.
1. Install dependencies:
```sh
npm install
```
2. Run the app in devlopment environment:
- ```cd configs```
- create ```dev.env``` file in the configs folder with the following content:
```touch dev.env```
```sh
NODE_ENV=development
MONGODB_LOCAL_URI=mongodb://localhost:27017/filesDB
ACCESS_TOKEN=
UPLOAD_PIN=
SIGN_COOKIE=
```
3. Make sure your mongoDB is running and accessible from your local machine.
4. Finally start the app
```sh
npm run devstart
```
# Running test cases
1. Install dependencies:
```sh
npm install
```
2. Make sure your mongoDB is running and accessible from your local machine.
3. Finally start the tests
```
npm run test
```
# Production api documentation
## [READ DOCS](https://documenter.getpostman.com/view/14307277/UzQyr4C8)
# Contributing
- Read the [Code of Conduct](./docs/code-of-conduct.md) first.
- Contibuting [guidelines](./docs/contributing/contributing.md)