Encontre, comunique, doe.
Explore the docs »

📚 Table of Contents

• 📖 About The Project
  • 📋 Features
  • 🔧 Built With
• 🚀 Getting Started
  • 📝 Prerequisites
  • ⚙️ Installation
• 🔗 Contributing
• 📜 License
• 📞 Contact

📖 About The Project

The easiest way to get rid of something you do not want anymore and at the same time help someone around you.

📋 Features

1. 💜 Register new donations
2. 📞 Direct contact with donator through WhatsApp or e-mail
3. 🗺 Find donations around you
4. 📐 Manage donations made
5. 📱 Responsiveness

🔧 Built With

• ReactJS
• NodeJS
• Express
• SQLite

🚀 Getting Started

📝 Prerequisites

You will be able to run this application if NodeJS and Yarn are installed at your machine.

⚙️ Installation

1. Open your terminal
2. Clone project (git clone https://github.com/cristianprochnow/FinDonation.git)
3. Install server packages (yarn)
4. Create a .env file within server/ and use .env_template as example to define variables and their values
5. Run back-end (yarn dev)
6. Install website packages (yarn)
7. Create a .env file within web/ and use .env_template as example to define variables and their values
8. Run front-end (yarn start)
9. 🎉 The magic is done!

If the browser not open automatically, search by the http://localhost:19000 URL at browser

🔗 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. 🍴 Fork the Project
2. 👯 Clone this project (git clone https://github.com/cristianprochnow/FinDonation.git)
3. 🔀 Create your Feature Branch (git checkout -b my-feature)
4. ✔️ Commit your Changes (git commit -m 'feat: My new feature')
5. 📌 Push to the Branch (git push origin my-feature)
6. 🔁 Open a Pull Request

📜 License

Distributed under the MIT License. See LICENSE for more information.

📞 Contact

Made with 💜 by Cristian Prochnow. Enjoy!