https://github.com/cristianprochnow/findonation
📍 Do you want to get rid of some item and also make a good act? So you can use this application to help people around you.
https://github.com/cristianprochnow/findonation
nodejs react sql tcc typescript
Last synced: 3 months ago
JSON representation
📍 Do you want to get rid of some item and also make a good act? So you can use this application to help people around you.
- Host: GitHub
- URL: https://github.com/cristianprochnow/findonation
- Owner: cristianprochnow
- License: mit
- Created: 2020-02-18T17:51:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-21T20:38:05.000Z (over 5 years ago)
- Last Synced: 2025-03-28T12:44:56.938Z (over 1 year ago)
- Topics: nodejs, react, sql, tcc, typescript
- Language: TypeScript
- Homepage:
- Size: 14.9 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Encontre, comunique, doe.
Explore the docs »
[![Author][author-shield]][author-url]
[![Languages][languages-shield]][languages-shield]
[![MIT License][license-shield]][license-url]
# 📚 Table of Contents
* [📖 About The Project](#-about-the-project)
* [📋 Features](#-features)
* [🔧 Built With](#-built-with)
* [🚀 Getting Started](#-getting-started)
* [📝 Prerequisites](#-prerequisites)
* [⚙️ Installation](#-installation)
* [🔗 Contributing](#-contributing)
* [📜 License](#-license)
* [📞 Contact](#-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.
![screen]
## 📋 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
- [x] ReactJS
- [x] NodeJS
- [x] Express
- [x] SQLite
# 🚀 Getting Started
## 📝 Prerequisites
You will be able to run this application if [NodeJS](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) 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
6. Run **front-end** (`yarn start`)
7. 🎉 The magic is done!
> If the browser not open automatically, search by the `http://localhost:19000` URL at browser
[![Run in Insomnia][insomnia-button]][insomnia-url]
# 🔗 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
[![Linkedin][linkedin-shield]][linkedin-url]
**Made with 💜 by Cristian Prochnow. Enjoy!**
[license-shield]: https://img.shields.io/github/license/cristianprochnow/FinDonation.svg?style=flat-square&color=%235B4FDB
[license-url]: https://github.com/cristianprochnow/FinDonation/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-Cristian_Prochnow-black.svg?style=flat-square&logo=linkedin&colorB=0077b4
[linkedin-url]: https://www.linkedin.com/in/cristianprochnow
[languages-shield]: https://img.shields.io/github/languages/count/cristianprochnow/FinDonation?color=%235B4FDB&style=flat-square
[author-shield]: https://img.shields.io/static/v1?label=author&message=Cristian%20Prochnow&color=5B4FDB&style=flat-square
[author-url]: https://github.com/cristianprochnow
[insomnia-button]: https://insomnia.rest/images/run.svg
[insomnia-url]: https://insomnia.rest/run/?label=FinDonation&uri=https%3A%2F%2Fgithub.com%2Fcristianprochnow%2FFinDonation%2Fblob%2Fmaster%2Fserver%2FInsomnia.json
[screen]: ./.github/screen.png