/the-mobb.com

The Map of Black Businesses (MoBB) allows clients to locate black owned businesses in their immediate vicinity, allowing increased support and patronage for visitors of new areas.

Primary LanguageTypeScriptMozilla Public License 2.0MPL-2.0

Github License Node Version W3C Validation

GitHub repo size Github code size Github Languages Github Top Language

GitHub Issues GitHub contributors Github Last Commit

The MOBB

The Map of Black Businesses (MOBB) is a tool to practice group economics. The application allows for consumers to immediately identify black owned businesses in their vicinity (or search another area on the map) with the goal of growing the community's economy.

Visit www.the-MOBB.com

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of node, and yarn.
  • You have a <Windows/Linux/Mac> machine. (I have not tested on Linux, but should work fine)
  • You have read SUPPORT.md.

Architecture

Documentation links can be found in SUPPORT

Contributing

First off, thank you for considering contributing to the MOBB. It’s people like you that make the MOBB such a great tool.

  1. Fork this repo
  2. Create a branch: git checkout -b <branch_name> (feature? bug?).
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin <project_name>/<location>
  5. Create the pull request. (Dont forget to test!)

Contributors

Thanks to the following people who have contributed to this project:

Licenses

Content is released under Mozilla Public License Version 2.0. See LICENSE.md for complete details, including attribution guidelines, contribution terms, and software and third-party licenses and permissions.

Roadmap as user stories

  • As an end-user, I would like to see the locations of black owned businesses near me, on a map
  • I would like to see the one closest business to me, at all times
  • I would like to see details of the busineses shown on the map
  • I would like to become a registered user
  • I would like to get directions to the business I am viewing
  • As a registered user, I would like to add a business to the map
  • As a registered user, I would like to modify business I am viewing
  • The map and business details should be current

Branches:

Try to name branches in a descriptive way, master, ft-<featureName>, fix-<fixName>, etc... No pull requests will be merged into master branch.

Resources:

Github Contribution setup