Giter Site home page Giter Site logo

stoned's Introduction

STONED API

https://shielded-garden-28851.herokuapp.com/

Description

An api that will return rock types and a rocks minerals, with some associated properties typically used by rockhounds in mineral identification. It currently lets users search by rock type & provides an option to search for a random mineral. Specifications for further exploration detailed below.

Technologies used / Prerequisites

Other Sources

Installation

  • $ git clone https://github.com/jinjin8/stoned
  • $ cd stoned

PostgreSQL Integration

  • $ postgres
  • $ rake db:create
  • $ rake db:migrate db:test:prepare

Seed database

  • $ rake db:seed

Development server

Run rails s for a dev server. Navigate to http://localhost:3000/. The app will automatically reload if you change any of the source files.

Specifications

Behavior Input Output
Add a rock type to the database Post, name => 'Igneous' message: "Added!"
Add minerals to the database Post, name => 'Tourmaline' message: "Added!"
Update a rock Put, name => 'Igneous' name: 'Igneous', id:1
Update a mineral Put, name => 'Tourmaline' name: 'Tourmaline', id:1
Delete a rock Visit a specific rock path, Delete message: "All out!"
Delete a mineral Visit a specific mineral path, Delete message: "All out!"
See a list of all minerals for a specific rock Visit 'rocks/:id/minerals' path name: 'Tourmaline'
Search for a mineral by rock type Visit '/rocks/by_name?name=Igneous' minerals: name:'Tourmaline'
Search for random minerals Visit 'rocks/:id/minerals/random' minerals: name: 'Corundum'

Further Exploration

Behavior Input Output
Search for minerals by color Visit 'rocks/:id/minerals/by_color?color=blue'
Search for minerals by crystal_system Visit 'rocks/:id/minerals/by_crystal_system?crystal_system=Isometric'
Search for minerals by category Visit 'rocks/:id/minerals/by_category?category=Halide'

Known Bugs

  • N/A

Support and contact details

[email protected]

License

MIT © 2017 jin camou

stoned's People

Contributors

gindiehl avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.