niyazed / neighbourhood

🇧🇩 Check your neighbourhood, if you can do something for them.

Prerequisites & Dependencies

• Node.js
• Geolocation API
• Leaflet.js
• Express
• NeDB
• Heroku CLI
• Google Chrome

Note - Use Google Chrome for Geolocation accessibilty. I've tested with Firefox but it's not working.

Getting Started

Make sure you have Node.js. The easiest way to get started is to clone the repository:

# Get the latest one
git clone https://github.com/niyazed/neighbourhood.git

# Change directory
cd neighbourhood

# Install NPM dependencies
npm install

# Then simply start your app
node index.js

Your app should now be running on localhost:3000.

Note: I highly recommend installing Nodemon. It watches for any changes in your node.js app and automatically restarts the server. Once installed, instead of node app.js use nodemon app.js. It will save you a lot of time in the long run, because you won't need to manually restart the server each time you make a small change in code. To install, run sudo npm install -g nodemon.

Screenshot

Contributing

If something is unclear, confusing, or needs to be refactored, please let me know. Pull requests are always welcome, but open an issue before submitting a pull request.

License

MIT License

Copyright (c) 2020 Niyaz Bin Hashem

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.