Skip to content

Commit 7e8ab74

Browse files
authored
Merge pull request #29 from jermbo/dev
updating index pages and other typos
2 parents cc09757 + 4d428ed commit 7e8ab74

File tree

9 files changed

+39
-22
lines changed

9 files changed

+39
-22
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Please note we have a [Code of Conduct](https://github.com/jermbo/SampleAPIs/blo
77
## Pull Request Process for new Databases
88

99
1. Create new folder with name describing data.
10-
2. Ensure index file has a list of end points dynamically added.
10+
2. Ensure index file has a list of endpoints dynamically added.
1111
1. Utilize the `displayEndPoints.js` file to accomplish this.
1212
3. Create json file with same name as folder. eg. `futurama.json`
1313
4. Create a `.backup` file of your json data. eg. `futurama.json.data`

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,9 @@ Once you get to an endpoint, you can do all the normal actions on a RESTful endp
1313
## Starting server locally
1414

1515
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.
16+
17+
#### Disclaimers
18+
19+
- The data on this site is for educational purposes only and is not owned by SampleAPIs.com
20+
- 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.
21+
-

avatar/index.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@
1515
<div class="site__inner">
1616
<a href="/" class="backBtn">Home</a>
1717
<h1 class="site__title">AvatarDB</h1>
18-
<p>A fun and safe place to practice with RESTful APIs</p>
18+
<p>If you are an Avatar fan, then this api is for you. Here you can find everything from Episodes to Characters
19+
to Trivia Questions and more.</p>
1920
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
2021
CORS and JSONP.</p>
2122
<article class="content">
22-
<p>Here is a list of existing APIs to get you started.</p>
23+
<p>Here are the endpoints currently available.</p>
2324
<nav class="endpoints">
2425
</nav>
2526
</article>

baseball/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
<div class="site__inner">
1616
<a href="/" class="backBtn">Home</a>
1717
<h1 class="site__title">BaseballDB</h1>
18-
<p>A fun and safe place to practice with RESTful APIs</p>
18+
<p>Baseball fans? Computer nerds? Now, in one place, you have baseball data and an api to access it. Have fun!</p>
1919
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
2020
CORS and JSONP.</p>
2121
<article class="content">
22-
<p>Here is a list of existing APIs to get you started.</p>
22+
<p>Here are the endpoints currently available.</p>
2323
<nav class="endpoints">
2424
</nav>
2525
</article>

fakebank/index.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,10 @@
1515
<div class="site__inner">
1616
<a href="/" class="backBtn">Home</a>
1717
<h1 class="site__title">FakeBankDB</h1>
18-
<p>A fun and safe place to practice with RESTful APIs</p>
19-
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
20-
CORS and JSONP.</p>
18+
<p>Building an app that needs some bake transactions? Well, look no further. Here are what Fry's bank statements
19+
might look like from the future.</p>
2120
<article class="content">
22-
<p>Here is a list of existing APIs to get you started.</p>
21+
<p>Here are the endpoints currently available.</p>
2322
<nav class="endpoints">
2423
</nav>
2524
</article>

futurama/index.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@
1515
<div class="site__inner">
1616
<a href="/" class="backBtn">Home</a>
1717
<h1 class="site__title">FuturamaDB</h1>
18-
<p>A fun and safe place to practice with RESTful APIs</p>
18+
<p>If you are a Futurama fan, then this api is for you. Here you can find everything from Episodes to Characters
19+
to Trivia Questions, and even some of the Products featured on the show.</p>
1920
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
2021
CORS and JSONP.</p>
2122
<article class="content">
22-
<p>Here is a list of existing APIs to get you started.</p>
23+
<p>Here are the endpoints currently available.</p>
2324
<nav class="endpoints">
2425
</nav>
2526
</article>

public/assets/styles/home-styles.css

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,16 @@ main {
2020
height: 100%;
2121
}
2222

23+
a {
24+
color: #15e3d9;
25+
}
26+
27+
.disclaimer {
28+
font-size: 0.75rem;
29+
}
30+
2331
.site {
24-
flex: 1 0 50%;
32+
flex: 2;
2533
display: flex;
2634
color: #eadeda;
2735
align-items: center;
@@ -51,7 +59,7 @@ main {
5159
}
5260

5361
.apis {
54-
flex: 1 0 50%;
62+
flex: 3;
5563
max-height: 100%;
5664
display: flex;
5765
overflow-y: auto;

public/index.html

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,22 @@
55
<meta charset="UTF-8">
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta http-equiv="X-UA-Compatible" content="ie=edge">
8-
<title>Test JSON</title>
8+
<title>Sample APIs</title>
99
<link rel="stylesheet" href="assets/styles/home-styles.css">
1010
</head>
1111

1212
<body>
1313
<main id="app">
1414
<article class="site">
1515
<div class="site__inner">
16-
<h1 class="site__title">{{title}}</h1>
17-
<p>{{desc}}</p>
18-
<p>{{thing}}</p>
16+
<h1 class="site__title">Sample APIs</h1>
17+
<p>Welcome to SampleAPIs. A playground for messing with RESTful endpoints. Checkout the project on
18+
<a href="https://github.com/jermbo/SampleAPIs">GitHub</a> and consider contributing to the project with a new endpoint!</p>
19+
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
20+
CORS and JSONP.</p>
21+
22+
<p class="disclaimer">The data on this site is for educational purposes only and is not owned by SampleAPIs.com</p>
23+
<p class="disclaimer">The data on this site will be reset on a regular basis.</p>
1924
</div>
2025
</article>
2126
<section class="apis">
@@ -38,12 +43,9 @@ <h2 class="api__title">{{api.title}}</h2>
3843
props: ['api'],
3944
});
4045
const app = new Vue({
41-
el: '#app',
46+
el: '.apis',
4247
data: function () {
4348
return {
44-
title: 'Sample APIs',
45-
desc: 'Here is a list of existing APIs to get you started.',
46-
thing: 'You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using CORS and JSONP.',
4749
apis: [
4850
{
4951
id: 1,

recipes/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<div class="site__inner">
1616
<a href="/" class="backBtn">Home</a>
1717
<h1 class="site__title">RecipesDB</h1>
18-
<p>A fun and safe place to practice with RESTful APIs</p>
18+
<p>Because everyone is making a recipe app to learn to code. So, here is some data.</p>
1919
<p>You can use any HTTP verbs (GET, POST, PUT, PATCH and DELETE) and access your resources from anywhere using
2020
CORS and JSONP.</p>
2121
<article class="content">

0 commit comments

Comments
 (0)