/zed-sharing-react

File sharing application built with React, TypeScript, WebRTC and socket-io

Primary LanguageTypeScriptMIT LicenseMIT

Logo

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

zed-showcase.mp4

Built with ✨

Running the app locally 🏠

To get a local copy up and running follow these simple steps.

  • Clone this repo (have git installed)
    git clone https://github.com/lucky-chap/zed-sharing-react.git
  • Install dependencies (have nodejs installed)
    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
  • Now run the app
    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 for more information.

Come say hi πŸ‘‹

Credits πŸ‘Œβš‘

Many thanks to all the people who helped me understand and build this. God bless y'all πŸ’¨