Steven Universe Gem API
Live Website: https://crystal-gem-api.herokuapp.com/
Docsify Brochure: https://noltron000.github.io/BEW-1-2_crystal-gem-api/
GitHub Repository: https://github.com/noltron000/BEW-1-2_crystal-gem-api
This API's goal is to help serve information about gem characters in the Steven Universe cartoon series in a more digestable format. Gem's have fusions and vice versa. Both of these items also have Special Weapons and Secret Powers.
What's Steven Universe? It's a popular cartoon directed by Rebecca Sugar.
Using the Website
The API has a modest frontend for ease of use. The website is hosted on Heroku @ https://crystal-gem-api.herokuapp.com/
||Displays basic information|
||Displays all gems|
||Displays all gems in
||Displays new gem form|
||Displays one gem's detail|
||Displays one gem's detail in
||Displays gem edit form|
||Displays all fusions|
||Displays all fusions in
||Displays new fusion form|
||Displays one fusion's detail|
||Displays one fusion's detail in
||Displays fusion edit form|
Getting Started Locally
Here's a step-by-step guide to set this API up locally on your computer.
- Set up project files locally
- Fork this repo.
- Open terminal;
cdinto your preferred repo library location
- Clone your new fork into this location
cdinto the new clone
- Host environment locally
yarn installin your terminal instance to initialize requirements
nodemonin your terminal to host the website locally
- navigate to
http://localhost:4040/in a browser of your choice
- modify and digest data that you alone can access
- TIP: this data is stored locally on your computer
- use the apps
/jsonroutes to retrieve data as you please
What are gems? Gems are metaphysical beings, and their form is projected from the heart of their existance - their jewel. Unlike people, gems can die many times, don't need to sleep, eat or breath, and have special weapons and secret powers.
What are fusions? Fusions are super-powerful combinations of gems, achieved through an extraordinary connection. Their mind and body form into one.
In future iterations, it would be nice to include:
- User provisioning
- Tests & error handling
- Structure refactoring