Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fasunle/file-sharer
Multi-user File sharing Application
https://github.com/fasunle/file-sharer
firebase-auth nodejs react react-query scss tailwindcss typescript vercel-deployment vitejs
Last synced: 2 days ago
JSON representation
Multi-user File sharing Application
- Host: GitHub
- URL: https://github.com/fasunle/file-sharer
- Owner: Fasunle
- Created: 2022-11-03T08:05:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-09T14:45:17.000Z (about 2 years ago)
- Last Synced: 2023-03-05T13:23:52.546Z (almost 2 years ago)
- Topics: firebase-auth, nodejs, react, react-query, scss, tailwindcss, typescript, vercel-deployment, vitejs
- Language: TypeScript
- Homepage: https://file-sharer.vercel.app
- Size: 983 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# File Sharing App
A file sharing application that allows one user to share a file with another user.
## Getting started
The app is easy to startup. In development mode, open the root directory and run the following `bash` command.
```bash
yarn dev
```
Alternatively, if you favour `npm` or do not have `yarn` installed already, use:
```bash
npm run dev
```
> If everything went well, open the app on `http://localhost:3000`
**NOTE:** It is assumed that you already have [nodejs](https://nodejs.org/) installed on your machine. You can download it [here](https://nodejs.org/).
## Deployment
The app can be deployed to production by various methods. For simplicity, we deploy to vercel.
The application is avalable in production at [here](https://file-sharer.vercel.app).
## Features
`/auth/signup` User Create an account with Email and Password only. They are dirrectly logged in upon successful signup.
`/auth/reset` User can change their password if the forgot or feel the password has been leaked.
`/auth/login` User sigin to the app. The signin is handled by firebase authentication. Information about the user is then stored to the database.
`/files` Displays list of all file shared with little information. User can click on each file to explore more information about the file.
`/files/:fileId` User can see all information about a file; including whom it is being shared with.
`/` This is a page where user can share files with another user.