README

B. Owned

This rails application allows for individuals to search for black owned businesses.

There is two ways to sign in: 1. As a business owner where you will be able to add companies that you own. 2. As a user who will be able to search for companies.

All users and owners have the ability to create personalized list that they can add muiltple companies too. In addition, a user/owner is able to follow/favorite companies of their liking. All users can delete/edit their list at any time.

Lastly, it allows an administrator to CRUD all functions in the app.

View Example View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This project allows a business owner to create a company and add its location which will be shown on the company show page using the google maps API Google_Maps_API

Built With

• Ruby-on-Rails
• byebug
• Google_Maps_API
• Blood 💉, Sweat 💦, and Tears 😢

Getting Started

To get the application started you must have ruby installed on your computer. Checkout the ruby on rails getting-started-guide to learn how to install it on your device.

Prerequisites

Before running your server, you will need to install the gems and add content to your database manually or you can use the seeds file:

To install the gems run the following:

bundle install

To run your migrations and update your db/schema.rb file to match the structure of the database, run the following:

rails db:migrate

To create data in the database, run the following:

rails db:seed

rails s

and then go to your favorite browser and visit this webpage "http://localhost:3000"

Installation

1. Get a free API Key at Google_Maps_API

2. Clone the repo

git clone https://github.com/SincerelyBrittany/b-owned.git

3. Install the gemfile packages

bundle install

4. Created a .env file, add the file to your gitignore, and enter your API KEYS:

  GOOGLE_KEY = "KEY_HERE"
  GOOGLE_CLIENT_ID = "ID_HERE"
  GOOGLE_CLIENT_SECRET = "SECRET_HERE"

Usage

View Demo on ways to use the application.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Connect/Follow me:

Acknowledgements

• Youtube
• Google
• Flatiron School