NBRLYU is a website designed to foster a sense of community and belonging among neighbors by enabling them to perform small acts of kindness for each other. The app aims to reduce loneliness and social isolation by creating opportunities for neighbors to connect with each other in meaningful ways.
Frontend
Backend
- Post requests for help or offer to help your neighbors with tasks such as cooking, cleaning, or yard work
- Connect with other neighbors and build relationships through acts of kindness
- Receive notifications when someone offers to help you or accepts your offer to help
To get a local copy up and running, follow these steps.
In order to run this project you need:
- React.js
- Firebase
- Node.js
- npm
- IDE (VSCode)Clone this repository to your desired folder:
cd nbrlyu
git clone https://github.com/Co-Lab-You-Belong-in-Tech/NBRLYU.gitInstall the frontend with:
Install the backend with:
To run the frontend of the project, execute the following command:
cd nbrlyu
npm install
npm start- Navigate to the app on your browser with the url
http://localhost:****where **** is the port number displayed on your terminal.
You can deploy this project using:
Example:
👤 Chris West
- GitHub: @Westc13
- LinkedIn: Chris West
Contributions, issues, and feature requests are welcome!
- Clone the repo with the command
git clone https://github.com/Co-Lab-You-Belong-in-Tech/NBRLYU.git - Pick an issue from the issues page and assign it to yourself
- Create your own branch from develop, eg feat/
- Ensure your branch is up to date with latest changes before pushing
- Create a pull request against develop branch
- Reference the issue you worked on in your PR
- Wait for your PR to be reviewed and merged
Give a ⭐️ if you like this project!
I would like to thank the following people for their support and guidance:
This project is MIT licensed.
NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.