/small-shops-big-community

This is the Rails API backend for Small Shops Big Community! This application allows users to search through shops and support a diverse community of shop owners in Los Angeles. The frontend for this project is here: https://github.com/LeahESc/small-shops-big-community-react

Primary LanguageRuby

README

SMALL SHOPS BIG COMMUNITY Application

Welcome to SMALL SHOPS BIG COMMUNITY backend! This is a yelp-style application made to champion small businesses and the richly diverse fabric of local shops in Los Angeles! This project uses a REACT front end and a Rails API for its backend. The frontend for this project can be found here: https://github.com/LeahESc/small-shops-big-community-react

Installation

Clone this repository, find the frontend and execute:

$npm install

To install all of the necessary react packages

In the backend, execute:

$rails db:migrate 

Then:

$rails db:seed 

This is necessary to begin using the app. The app is both open-sourced but also includes a bunch of pre-seeded data.

Usage

Usage of this React-Redux app is to allow a user to search for and find independently-owned shops and businesses in LA.

Contributing

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The app is available as open source under the terms of the MIT License.