Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucky-chap/zed-sharing-react
File sharing application built with React, TypeScript, WebRTC and socket-io
https://github.com/lucky-chap/zed-sharing-react
react webrtc
Last synced: 2 days ago
JSON representation
File sharing application built with React, TypeScript, WebRTC and socket-io
- Host: GitHub
- URL: https://github.com/lucky-chap/zed-sharing-react
- Owner: lucky-chap
- License: mit
- Created: 2022-06-15T10:56:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-01T16:48:05.000Z (over 2 years ago)
- Last Synced: 2024-04-28T01:14:21.545Z (9 months ago)
- Topics: react, webrtc
- Language: TypeScript
- Homepage: https://zed-sharing.vercel.app
- Size: 13.5 MB
- Stars: 25
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
zed-sharing-react
Frontend for file sharing app built with the MERN Stack
Report Bug
·
Request Feature
## About The Project 😶🌫️
This is the Frontend for Zed, a file sharing platform I built for the Linode and Hashnode Hackathon ✨🎉 You can find the backend code [here](https://github.com/lucky-chap/zed-sharing-node)
https://user-images.githubusercontent.com/67266933/176912398-c245deb3-ab90-40f0-a7f9-f059fe49445c.mp4
### Built with ✨
- [ReactJS](https://reactjs.org/)
- [MobX](https://mobx.js.org/)
- [WebRTC](https://webrtc.org/)
- [SocketIO](https://socket.io/)
- [StyledComponents](https://styled-components.com/)
## Running the app locally 🏠
To get a local copy up and running follow these simple steps.
- Clone this repo (have git installed)
```sh
git clone https://github.com/lucky-chap/zed-sharing-react.git
```
- Install dependencies (have nodejs installed)
```sh
cd zed-sharing-react
yarn install # or npm install
```
- Make sure you create a `.env.local` file and fill it with `.env.example` as reference
- In order for this app to work, you'd have to have the backend. Mine's over [here](https://github.com/lucky-chap/zed-sharing-node)
- Now run the app
```sh
yarn start
```
## Contributing ➕
You rock! Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull
request. You can also simply open an issue with any appropriate tag. Don't forget to give the
project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/coolStuff`)
3. Commit your Changes (`git commit -m 'Add some coolStuff'`)
4. Push to the Branch (`git push origin feature/coolStuff`)
5. Open a Pull Request
## License 📜
Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.
## Come say hi 👋
- Twitter: [@hunchodotdev](https://twitter.com/hunchodotdev)
- Discord: [@FatKidOnFiree#1355](https://discordapp.com/users/FatKidOnFiree#1355)
- Reddit: [@huncho_dot_dev](https://www.reddit.com/user/huncho_dot_dev/)
## Credits 👌⚡
Many thanks to all the people who helped me understand and build this. God bless y'all 💨