Skip to content

Commit

Permalink
Merge pull request #29 from jermbo/dev
Browse files Browse the repository at this point in the history
updating index pages and other typos
  • Loading branch information
jermbo authored Jul 26, 2018
2 parents a1cb5a4 + b36409c commit 42903cb
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 22 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Please note we have a [Code of Conduct](https://github.com/jermbo/SampleAPIs/blo
## Pull Request Process for new Databases

1. Create new folder with name describing data.
2. Ensure index file has a list of end points dynamically added.
2. Ensure index file has a list of endpoints dynamically added.
1. Utilize the `displayEndPoints.js` file to accomplish this.
3. Create json file with same name as folder. eg. `futurama.json`
4. Create a `.backup` file of your json data. eg. `futurama.json.data`
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,9 @@ Once you get to an endpoint, you can do all the normal actions on a RESTful endp
## Starting server locally

Navigate to the folder containing the cloned files. Install dependencies `npm i`. Once all the dependencies are loaded, run `npm start`. Open your browser to `localhost:5000`. Use the site the same way you would from the website.

#### Disclaimers

- The data on this site is for educational purposes only and is not owned by SampleAPIs.com
- Data will be reset back to its original state on a regular basis. If you are updating or adding to data to the endpoints and want to have them present, contribute to the repo by submitting a pull request.
-
5 changes: 3 additions & 2 deletions avatar/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@
<div class="site__inner">
<a href="/" class="backBtn">Home</a>
<h1 class="site__title">AvatarDB</h1>
<p>A fun and safe place to practice with RESTful APIs</p>
<p>If you are an Avatar fan, then this api is for you. Here you can find everything from Episodes to Characters
to Trivia Questions and more.</p>
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
CORS and JSONP.</p>
<article class="content">
<p>Here is a list of existing APIs to get you started.</p>
<p>Here are the endpoints currently available.</p>
<nav class="endpoints">
</nav>
</article>
Expand Down
4 changes: 2 additions & 2 deletions baseball/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
<div class="site__inner">
<a href="/" class="backBtn">Home</a>
<h1 class="site__title">BaseballDB</h1>
<p>A fun and safe place to practice with RESTful APIs</p>
<p>Baseball fans? Computer nerds? Now, in one place, you have baseball data and an api to access it. Have fun!</p>
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
CORS and JSONP.</p>
<article class="content">
<p>Here is a list of existing APIs to get you started.</p>
<p>Here are the endpoints currently available.</p>
<nav class="endpoints">
</nav>
</article>
Expand Down
7 changes: 3 additions & 4 deletions fakebank/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@
<div class="site__inner">
<a href="/" class="backBtn">Home</a>
<h1 class="site__title">FakeBankDB</h1>
<p>A fun and safe place to practice with RESTful APIs</p>
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
CORS and JSONP.</p>
<p>Building an app that needs some bake transactions? Well, look no further. Here are what Fry's bank statements
might look like from the future.</p>
<article class="content">
<p>Here is a list of existing APIs to get you started.</p>
<p>Here are the endpoints currently available.</p>
<nav class="endpoints">
</nav>
</article>
Expand Down
5 changes: 3 additions & 2 deletions futurama/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@
<div class="site__inner">
<a href="/" class="backBtn">Home</a>
<h1 class="site__title">FuturamaDB</h1>
<p>A fun and safe place to practice with RESTful APIs</p>
<p>If you are a Futurama fan, then this api is for you. Here you can find everything from Episodes to Characters
to Trivia Questions, and even some of the Products featured on the show.</p>
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
CORS and JSONP.</p>
<article class="content">
<p>Here is a list of existing APIs to get you started.</p>
<p>Here are the endpoints currently available.</p>
<nav class="endpoints">
</nav>
</article>
Expand Down
12 changes: 10 additions & 2 deletions public/assets/styles/home-styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,16 @@ main {
height: 100%;
}

a {
color: #15e3d9;
}

.disclaimer {
font-size: 0.75rem;
}

.site {
flex: 1 0 50%;
flex: 2;
display: flex;
color: #eadeda;
align-items: center;
Expand Down Expand Up @@ -51,7 +59,7 @@ main {
}

.apis {
flex: 1 0 50%;
flex: 3;
max-height: 100%;
display: flex;
overflow-y: auto;
Expand Down
18 changes: 10 additions & 8 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,22 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Test JSON</title>
<title>Sample APIs</title>
<link rel="stylesheet" href="assets/styles/home-styles.css">
</head>

<body>
<main id="app">
<article class="site">
<div class="site__inner">
<h1 class="site__title">{{title}}</h1>
<p>{{desc}}</p>
<p>{{thing}}</p>
<h1 class="site__title">Sample APIs</h1>
<p>Welcome to SampleAPIs. A playground for messing with RESTful endpoints. Checkout the project on
<a href="https://github.com/jermbo/SampleAPIs">GitHub</a> and consider contributing to the project with a new endpoint!</p>
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
CORS and JSONP.</p>

<p class="disclaimer">The data on this site is for educational purposes only and is not owned by SampleAPIs.com</p>
<p class="disclaimer">The data on this site will be reset on a regular basis.</p>
</div>
</article>
<section class="apis">
Expand All @@ -38,12 +43,9 @@ <h2 class="api__title">{{api.title}}</h2>
props: ['api'],
});
const app = new Vue({
el: '#app',
el: '.apis',
data: function () {
return {
title: 'Sample APIs',
desc: 'Here is a list of existing APIs to get you started.',
thing: 'You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using CORS and JSONP.',
apis: [
{
id: 1,
Expand Down
2 changes: 1 addition & 1 deletion recipes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<div class="site__inner">
<a href="/" class="backBtn">Home</a>
<h1 class="site__title">RecipesDB</h1>
<p>A fun and safe place to practice with RESTful APIs</p>
<p>Because everyone is making a recipe app to learn to code. So, here is some data.</p>
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
CORS and JSONP.</p>
<article class="content">
Expand Down

0 comments on commit 42903cb

Please sign in to comment.