Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrewjbateman/timestampunix

:clipboard: Gives the UNIX-time generated from a user date input
https://github.com/andrewjbateman/timestampunix

express glitch heroku javascript json node nodejs npm npm-module

Last synced: 3 days ago
JSON representation

:clipboard: Gives the UNIX-time generated from a user date input

Host: GitHub
URL: https://github.com/andrewjbateman/timestampunix
Owner: AndrewJBateman
Created: 2018-05-14T09:54:21.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-03-28T00:28:16.000Z (11 months ago)
Last Synced: 2024-12-27T02:44:44.390Z (about 2 months ago)
Topics: express, glitch, heroku, javascript, json, node, nodejs, npm, npm-module
Language: HTML
Homepage:
Size: 458 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # :zap: Timestamp Microservice for FCC

* Returns UNIX and UTC timestamps for date inputs or current date/time

* This was part of the FreeCodeCamp exercises for Front End Certification

* **Note:** to open web links in a new window use: _ctrl+click on link_

![GitHub repo size](https://img.shields.io/github/repo-size/AndrewJBateman/TimestampUNIX?style=plastic)

![GitHub pull requests](https://img.shields.io/github/issues-pr/AndrewJBateman/TimestampUNIX?style=plastic)

![GitHub Repo stars](https://img.shields.io/github/stars/AndrewJBateman/TimestampUNIX?style=plastic)

![GitHub last commit](https://img.shields.io/github/last-commit/AndrewJBateman/TimestampUNIX?style=plastic)

## :page_facing_up: Table of contents

* [:zap: Timestamp Microservice for FCC](#zap-timestamp-microservice-for-fcc)

  * [:page_facing_up: Table of contents](#page_facing_up-table-of-contents)

  * [:books: General info](#books-general-info)

  * [:camera: Screenshots](#camera-screenshots)

  * [:signal_strength: Technologies](#signal_strength-technologies)

  * [:floppy_disk: Setup](#floppy_disk-setup)

  * [:computer: Code Examples](#computer-code-examples)

  * [:cool: Features](#cool-features)

  * [:clipboard: Status & To-Do List](#clipboard-status--to-do-list)

  * [:clap: Inspiration](#clap-inspiration)

  * [:envelope: Contact](#envelope-contact)

## :books: General info

* Original instructions (User Stories) from FCC:

1. The API endpoint is `GET [project_url]/api/timestamp/:date_string?`

2. A date string is valid if it 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": , "utc" :  }`

e.g. `{"unix": 1479663089000 ,"utc": "Sun, 20 Nov 2016 17:31:29 GMT"}`.

5. If the date string is **invalid** the api returns JSON having the structure `{"unix": null, "utc" : "Invalid Date" }`. It is what you get from the date manipulation functions used above.

## :camera: Screenshots

![Example screenshot](./img/home.png).

![Example screenshot](./img/timestamp.png).

## :signal_strength: Technologies

* [Node v16](https://nodejs.org/en/) javaScript runtime built on Chrome's V8 JavaScript engine

* [Express v4](https://expressjs.com/) Fast, unopinionated, minimalist web framework for Node.js. Includes body-parsing

* [Cors v2](https://www.npmjs.com/package/cors) node.js package for providing Connect/Express middleware that can be used to enable CORS with various options.

## :floppy_disk: Setup

* `npm i` to install dependencies

* `npm run start` for a dev server.

* Navigate to `http://localhost:8080/` for home screen.

* Navigate to `http://localhost:8080/api/timestamp/` for current time stamp

* Navigate to `http://localhost:8080/api/timestamp/2022-04-12` date-string for example to see json object with unix and utc timestamps

* Navigate to `http://localhost:8080/api/timestamp/1598659200` unix timestamp for example to see json object with unix and utc timestamps

* The app will not automatically reload if you change any of the source files.

## :computer: Code Examples

* extract from `server.js` to return current timestamp

```javascript

// API endpoint for no date entry...

app.get("/api/timestamp/", function (req, res) {

  let dateNow = new Date()

  res.json({

    unix: dateNow.getTime(),

    utc: dateNow.toUTCString()

  });

});

```

## :cool: Features

* UNIX and UTC timestamps shown

## :clipboard: Status & To-Do List

* Status: Working

* To-Do: Nothing

## :clap: Inspiration

* [freeCodeCamp's APIs and Microservices Projects - Timestamp Microservice](https://www.freecodecamp.org/learn/apis-and-microservices/apis-and-microservices-projects/timestamp-microservice)

* [Express doc: Serving static files in Express](http://expressjs.com/en/starter/static-files.html) such as images, CSS files, and JavaScript files

* [Express doc: Basic Routing](http://expressjs.com/en/starter/basic-routing.html) basic structure: `app.METHOD(PATH, HANDLER)`

## :envelope: Contact

* Repo created by [ABateman](https://github.com/AndrewJBateman), email: [email protected]