/sprint-1-api

Primary LanguageRuby

Ruby API Build - First Sprint

The purpose of the first sprint was to create a bangazon api. This api allows access to the company's inventory/internal database.

Getting Started

These instructions will get you a copy of our API up and running on your local machine for development and testing purposes.

Prerequisites

To run this api, you will need three gems:

'rails', '~> 5.1.4'
'sqlite3'
'rack-cors', '>= 1.0.2'

These will be installed once you run bundle install.

  • For windows users, you will need to install an additional gem: gem 'wdm', '>= 0.1.0'

Installing

How to run the api:

  1. Fork the repo.
  2. Open it in terminal and CD into the directory
  3. Clone repo
  4. Run bundle install.
  5. Run rails db:migrate.
  6. Run rails server.
  7. Go to schema.rb and find path to add dummy data (this should be appended to the localhost url - ex: localhost:3000/orders).

Endpoints

To view all endpoints, click here!

Adding sample data - (example: data for customer table)

  1. Go to Postman
  2. Select POST
  3. URL is localhost:3000/customers
  4. Click body, then raw, JSON
  5. Paste in the below block into the body of the request:
{
 "customer": {
    "first_name": "Lee",
    "last_name": "Milton",
    "stale": false,
    "last_date_active": "10-11-2017",
    "active": true
    }
 }
  1. Click send

Contributing

If you feel the need to contribute to this project, follow the steps below:

  1. Go to the repository (https://github.com/Puddlemere-United/sprint-1-api).
  2. Fork the repository to your github account.
  3. Clone the repository to your local directory.
  4. Finally follow the "Installation" steps above to get the API up and running.

Issue Reporting

  1. To report an issue, click the Issue tab within this repository on Github.
  2. Click 'New issue'
  3. Create an issue ticket clearly summarizing the issue in the Title field, and giving steps to recreate the issue in the 'Leave a comment' field.
    • Please be as specific as possible in order to allow for quick fixes.

Authors

LaKeshia Johnson, Jordan Berghofer, Tyler Barnett, Nora Moser

Acknowledgments

  • Thank you to Casey Dailey and Jisie David