README.md

Foodfy

LaunchBase 🚀

Project   |    Technologies   |    How to use   |    How to contribute   |    License

💻 Project

Foodfy is an App where people can share all of their recipes in the Web.

---

🚀 Technologies

• 💹 Nodejs — A JavaScript runtime
• 🔵 Express — A web framework for Node Js
• 💹 PostgreSQL — A DBMS well known and very reliable.
• 💹 Nodemailer — A lib that makes possible to send emails from the app.

ℹ️ How To Use

To clone and run this application, you'll need Git, Node.js + PostgreSQL installed on your computer.

Install Front-end

# Clone this repository
$ git clone https://github.com/Gui-Devz/Foodfy-v2.0.git

# Go into the repository
$ cd foodfy-v2.0

# Install dependencies
$ npm install

# Run
$ npm start

# running on port 3000

:alert: Important

• Go to 'src/config/mailer.js', there you'll have to fill all the fields using the 'SMTP Settings' that is given in the website 'mailtrap.io'. Like shown in the image bellow.

  

✍️ How to contribute

• Make a fork;
• Create a branch with your feature: git checkout -b my-feature;
• Commit changes: git commit -m 'feat: My new feature';
• Make a push to your branch: git push origin my-feature.

After merging your receipt request to done, you can delete a branch from yours.

License

his project is under the MIT license.

Made with ♥ by Guilherme Zagari 👋 Get in touch!