zed-sharing-node
Backend for file sharing app built with the MERN Stack
Report Bug · Request Feature
😶🌫️
About The Project This is the API for Zed, a file sharing platform built for the Hashnode and Linode Hackathon
zed-showcase.mp4
✨
Built with
🏠
Running the server 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-node.git
- Install dependencies (have nodejs installed)
cd zed-sharing-node yarn install # or npm install
- Make sure you create a
.env
file and fill it with.env.example
as reference - In config.js, remove the
dialectOptions
object as you would not be needing it in development - Build, seed and migrate the database all together
yarn build
- Now run the server
yarn start
🏨
Running the server in production 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-node.git
- Install dependencies (have nodejs installed)
cd zed-sharing-node yarn install # or npm install
- Make sure you create a
.env
file and fill it with.env.example
as reference - Also remember to add an SSL certificate file to the
root
folder sosequelize
can read from there. This is required to connect to the MySQL database on your server - Build, seed and migrate the database all together
yarn build
- Now run the server
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 the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/coolStuff
) - Commit your Changes (
git commit -m 'Add some coolStuff'
) - Push to the Branch (
git push origin feature/coolStuff
) - Open a Pull Request
📜
License Distributed under the MIT License. See LICENSE for more information.
👋
Come say hi - Twitter: @hunchodotdev
- Discord: @FatKidOnFiree#1355
- Reddit: @huncho_dot_dev