Welcome to Shop-POC’s documentation!

https://img.shields.io/static/v1?label=license&message=MIT&color=redLicense: MIT https://travis-ci.com/KathyLau/shop-poc.png?branch=masterBuild Status https://codecov.io/gh/KathyLau/shop-poc/branch/master/graph/badge.svgcodecov https://readthedocs.org/projects/shop-poc/badge/?version=latestDocumentation Status

In light of recent protests and the increased participation in the Black Lives Matter Movement, Shop-POC is a response in the form of an interactive map of small, black-owned and POC-owned businesses in New York City which aims to allow users to easily find ways to shop small and support POC businesses near them.

Key features

  • Users will be able to search by location, business type, and distance

  • Users will be able to see buisnesses on the map as pop up pins

  • Users will be able to click on the pins to see images and google reviews

  • Users will be able to suggest more POC-owned businesses to add to the map

How to Download

Project still in development

Licensing

Shop-POC is licensed under the MIT Licence as of 2020

User Documentation

Getting Started

  • Shop-POC attempts to use the Google Maps API and data from NYC Open Data to allow users to easily find small, POC-owned buisnesses in New York City by location, business type, and distance on the Google Maps API

Features and functionality

  • Able to search for POC-owned businesses by business type, borough in New York City, and distance away

  • Next Features to be implemented: Able to register users to leave reviews

Tutorials/Code Examples

https://limitless-dawn-67321.herokuapp.com/

Existing Extensions and Integrations

None

FAQ

To be determined

Release Notes and Version Info

Version 0.4.0

Developer Documentation

Currently, Shop-POC has created a GitHub repository, added testing files, set up automated testing, code coverage and linting

CI Documentation

  • Currently the use of 2 branches allows developers to continuously develop, test, and add features to the main repository shop-poc

Testing, Linting and Styling Documentation

  • Currently Shop-POC uses flake8 for linting and has employed

  • Testing is stored in tests/ and uses a mix of unit and integration tests for both function and database testing

Extensions and Integration authors

  • Currently no extentions or integration authors

Release Notes and Roadmap

  • Version 0.4.0 is functional for use or download, but not fully complete

  • Current release has integrated use of the Google Maps API and added a create page, on top of existing structure from Version 0.3.0

API Documentation

  • Shop-POC uses the Google Maps API. Further API documentation can be found here