fix: remove user stories from landing page and readme (#43)
* fix: remove user stories from landing page and readme * fix: update favicon, title
This commit is contained in:
parent
788466b640
commit
74da23725f
21
README.md
21
README.md
@ -1,21 +1,2 @@
|
||||
|
||||
# API Project: Timestamp Microservice for FCC
|
||||
|
||||
### User stories:
|
||||
|
||||
[![Run on Repl.it](https://repl.it/badge/github/freeCodeCamp/boilerplate-project-timestamp)](https://repl.it/github/freeCodeCamp/boilerplate-project-timestamp)
|
||||
|
||||
1. The API endpoint is `GET [project_url]/api/timestamp/:date_string?`
|
||||
2. A date string is valid if can be successfully parsed by `new Date(date_string)` (JS) . Note that the unix timestamp needs to be an **integer** (not a string) specifying **milliseconds**. In our test we will use date strings compliant with ISO-8601 (e.g. `"2016-11-20"`) because this will ensure an UTC timestamp.
|
||||
3. If the date string is **empty** it should be equivalent to trigger `new Date()`, i.e. the service uses the current timestamp.
|
||||
4. If the date string is **valid** the api returns a JSON having the structure
|
||||
`{"unix": <date.getTime()>, "utc" : <date.toUTCString()> }`
|
||||
e.g. `{"unix": 1479663089000 ,"utc": "Sun, 20 Nov 2016 17:31:29 GMT"}`.
|
||||
5. If the date string is **invalid** the api returns a JSON having the structure `{"error" : "Invalid Date" }`.
|
||||
|
||||
#### Example usage:
|
||||
* https://Timestamp-Microservice--freecodecamp.repl.co/api/timestamp/2015-12-25
|
||||
*https://Timestamp-Microservice--freecodecamp.repl.co/api/timestamp/1451001600000
|
||||
|
||||
#### Example output:
|
||||
* {"unix":1451001600000, "utc":"Fri, 25 Dec 2015 00:00:00 GMT"}
|
||||
# [Timestamp Microservice](https://www.freecodecamp.org/learn/apis-and-microservices/apis-and-microservices-projects/timestamp-microservice)
|
||||
|
@ -18,25 +18,21 @@ h3 {
|
||||
margin-top: 30px;
|
||||
}
|
||||
|
||||
hr {
|
||||
margin: 25px;
|
||||
}
|
||||
|
||||
.footer {
|
||||
margin-top: 40px;
|
||||
}
|
||||
|
||||
.user-stories {
|
||||
position: relative;
|
||||
text-align: justify;
|
||||
max-width: 700px;
|
||||
margin: 15px auto;
|
||||
}
|
||||
code {
|
||||
font-family: monospace;
|
||||
padding: 2px;
|
||||
color: black;
|
||||
background-color: #fff;
|
||||
}
|
||||
ol {
|
||||
list-style-position: outside;
|
||||
}
|
||||
|
||||
ul {
|
||||
list-style-type: none;
|
||||
}
|
||||
@ -44,9 +40,6 @@ ul {
|
||||
li {
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
.user-stories li {
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #2574A9;
|
||||
|
@ -1,49 +1,32 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<title>Timestamp Microservice</title>
|
||||
<link rel="shortcut icon" href="https://cdn.hyperdev.com/us-east-1%3A52a203ff-088b-420f-81be-45bf559d01b1%2Ffavicon.ico" type="image/x-icon"/>
|
||||
<title>Timestamp Microservice | freeCodeCamp.org</title>
|
||||
<link rel="shortcut icon" href="https://cdn.freecodecamp.org/universal/favicons/favicon-32x32.png" type="image/x-icon"/>
|
||||
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet" type="text/css">
|
||||
<link href="style.css" rel="stylesheet" type="text/css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Timestamp Microservice</h1>
|
||||
<hr />
|
||||
<div class="container">
|
||||
<h3>Example Usage:</h3>
|
||||
<ul>
|
||||
<li><a href="api/timestamp/2015-12-25">[project url]/api/timestamp/2015-12-25</a></li>
|
||||
<li><a href="api/timestamp/1451001600000">[project url]/api/timestamp/1451001600000</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="container">
|
||||
<h2>API Project: Timestamp Microservice</h2>
|
||||
<h3>User Stories:</h3>
|
||||
<ol class="user-stories">
|
||||
|
||||
<li>The API endpoint is <code>GET [project_url]/api/timestamp/:date_string?</code></li>
|
||||
<li>A date string is valid if can be successfully parsed by <code>new Date(date_string)</code>.<br>
|
||||
Note that the unix timestamp needs to be an <strong>integer</strong> (not a string) specifying <strong>milliseconds</strong>.<br>
|
||||
In our test we will use date strings compliant with ISO-8601 (e.g. <code>"2016-11-20"</code>) because this will ensure an UTC timestamp.</li>
|
||||
<li>If the date string is <strong>empty</strong> it should be equivalent to trigger <code>new Date()</code>, i.e. the service uses the current timestamp.</li>
|
||||
<li>If the date string is <strong>valid</strong> the api returns a JSON having the structure<br><code>{"unix": <date.getTime()>, "utc" : <date.toUTCString()> }</code><br>
|
||||
e.g. <code>{"unix": 1479663089000 ,"utc": "Sun, 20 Nov 2016 17:31:29 GMT"}</code></li>
|
||||
<li>If the date string is <strong>invalid</strong> the api returns a JSON having the structure <br>
|
||||
<code>{"error" : "Invalid Date" }</code>.
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<h3>Example Usage:</h3>
|
||||
<ul>
|
||||
<li><a href="api/timestamp/2015-12-25">[project url]/api/timestamp/2015-12-25</a></li>
|
||||
<li><a href="api/timestamp/1451001600000">[project url]/api/timestamp/1451001600000</a></li>
|
||||
</ul>
|
||||
|
||||
<h3>Example Output:</h3>
|
||||
<p>
|
||||
<code>{"unix":1451001600000, "utc":"Fri, 25 Dec 2015 00:00:00 GMT"}</code>
|
||||
</p>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<p>
|
||||
By <a href="https://www.freecodecamp.org/">freeCodeCamp</a>
|
||||
</p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
<h3>Example Output:</h3>
|
||||
<p>
|
||||
<code>{"unix":1451001600000, "utc":"Fri, 25 Dec 2015 00:00:00 GMT"}</code>
|
||||
</p>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<p>
|
||||
By <a href="https://www.freecodecamp.org/">freeCodeCamp.org</a>
|
||||
</p>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
Loading…
Reference in New Issue
Block a user