Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gonzagadavid/calendar-json-api
The Calendar JSON API can be used to provide you with a calendar formatted as a 2D array. For that, you may choose to query for the selected month, or the selected year, as explained in the endpoints below.
https://github.com/gonzagadavid/calendar-json-api
api backend calendar eslint express jest json supertest swagger tsnode typescript
Last synced: about 4 hours ago
JSON representation
The Calendar JSON API can be used to provide you with a calendar formatted as a 2D array. For that, you may choose to query for the selected month, or the selected year, as explained in the endpoints below.
- Host: GitHub
- URL: https://github.com/gonzagadavid/calendar-json-api
- Owner: Gonzagadavid
- License: mit
- Created: 2021-12-18T03:31:03.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-13T18:23:41.000Z (over 1 year ago)
- Last Synced: 2023-05-13T21:38:20.673Z (over 1 year ago)
- Topics: api, backend, calendar, eslint, express, jest, json, supertest, swagger, tsnode, typescript
- Language: TypeScript
- Homepage: https://calendar-json-app.adaptable.app/month
- Size: 489 KB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Calendar JSON API {...} :calendar:
## Sumary
- [Introduction](#introduction)
- [Instructions to start locally](#instructions-to-start-locally)
- [Swagger documentation](#swagger-documentation)
- [Endpoints](#endpoints)
- [Current month](#current-month)
- [Month name](#month-name)
- [Month name and year](#month-name-and-year)
- [Current year](#current-year)
- [Year](#year)
- [Technologies](#technologies)
- [Tests](#tests)
- [Instructions to start tests locally](#instructions-to-start-tests-locally)
- [Deployment](#deployment)
---
# Introduction
The Calendar JSON API can be used to provide you with a calendar formatted as a 2D array.
For that, you may choose to query for the selected month, or the selected year, as explained in the endpoints below.
---
# Swagger documentation
Access the swagger documentation:
Production: https://calendar-json-app.adaptable.app/docs
Local: `http://localhost:3002/docs`
---
# Instructions to start locally
- clone the repository `git clone [email protected]:Gonzagadavid/calendar-json-api.git`
- enter the directory `cd calendar-json-api`
- install the dependencies `npm install`
- run the command `npm run dev`
- the api will be available at `http://localhost:3002`
---
# Endpoints
## Current month /month
Returns the calendar of the current date.
```url
GET https://calendar-json-app.adaptable.app/month
```
*E.G:*
Being the current date December 2021, the default response will be:
```json
{
"December":[
[ 0, 0, 0, 1, 2, 3, 4],
[ 5, 6, 7, 8, 9, 10, 11],
[ 12, 13, 14, 15, 16, 17, 18],
[ 19, 20, 21, 22, 23, 24, 25],
[ 26, 27, 28, 29, 30, 31, 0]
],
"year": 2021
}
```
*I.E:*
**December 2021**
| Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday |
| :-----:| :-----:| :------:| :--------:| :-------:| :-----:| :-------:|
| | | | 1 | 2 | 3 | 4 |
| 5 | 6 | 7 | 8 | 9 | 10 | 11 |
| 12 | 13 | 14 | 15 | 16 | 17 | 18 |
| 19 | 20 | 21 | 22 | 23 | 24 | 25 |
| 26 | 27 | 28 | 29 | 30 | 31 | |
---
## Month name /month/\
Returns current year`s month calendar.
```url
GET https://calendar-json-app.adaptable.app/month/
```
*E.G:*
Being 2021 the current year, and November the desired month, the request must be sent as follows:
```url
GET https://calendar-json-app.adaptable.app/month/november
```
And the response will be:
```json
{
"November":[
[ 0, 1, 2, 3, 4, 5, 6],
[ 7, 8, 9, 10, 11, 12, 13],
[ 14, 15, 16, 17, 18, 19, 20],
[ 21, 22, 23, 24, 25, 26, 27],
[ 28, 29, 30, 0, 0, 0, 0]
],
"year": 2021
}
```
*I.E:*
**November 2021**
| Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday |
| :-----:| :-----:| :------:| :--------:| :-------:| :-----:| :-------:|
| | 1 | 2 | 3 | 4 | 5 | 6 |
| 7 | 8 | 9 | 10 | 11 | 12 | 13 |
| 14 | 15 | 16 | 17 | 18 | 19 | 20 |
| 21 | 22 | 23 | 24 | 25 | 26 | 27 |
| 28 | 29 | 30 | | | | |
---
## Month name and year /month/\?year=\
Returns the calendar for the desired month and year.
```url
GET https://calendar-json-app.adaptable.app/month/?year=
```
*E.G:*
Desired month: October
Desired year: 2012
```url
GET https://calendar-json-app.adaptable.app/month/october?year=2012
```
And the response will be:
```json
{
"October":[
[ 0, 1, 2, 3, 4, 5, 6],
[ 7, 8, 9, 10, 11, 12, 13],
[ 14, 15, 16, 17, 18, 19, 20],
[ 21, 22, 23, 24, 25, 26, 27],
[ 28, 29, 30, 31, 0, 0, 0]
],
"year": 2012
}
```
*I.E:*
**October 2012**
| Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday |
| :-----:| :-----:| :------:| :--------:| :-------:| :-----:| :-------:|
| | 1 | 2 | 3 | 4 | 5 | 6 |
| 7 | 8 | 9 | 10 | 11 | 12 | 13 |
| 14 | 15 | 16 | 17 | 18 | 19 | 20 |
| 21 | 22 | 23 | 24 | 25 | 26 | 27 |
| 28 | 29 | 30 | 31 | | | |
---
## Current year /fullyear
Returns the complete calendar for the current year.
```url
GET https://calendar-json-app.adaptable.app/fullyear
```
*E.G:*
Being the current year 2021, the response will be:
```json
{
"year":2021,
"January":[
[ 0, 0, 0, 0, 0, 1, 2],
[ 3, 4, 5, 6, 7, 8, 9],
[ 10, 11, 12, 13, 14, 15, 16],
[ 17, 18, 19, 20, 21, 22, 23],
[ 24, 25, 26, 27, 28, 29, 30],
[ 31, 0, 0, 0, 0, 0, 0]
],
"February":[
[ 0, 1, 2, 3, 4, 5, 6],
[ 7, 8, 9, 10, 11, 12, 13],
[ 14, 15, 16, 17, 18, 19, 20],
[ 21, 22, 23, 24, 25, 26, 27],
[ 28, 0, 0, 0, 0, 0, 0]
],
"March":[
[ 0, 1, 2, 3, 4, 5, 6],
[ 7, 8, 9, 10, 11, 12, 13],
[ 14, 15, 16, 17, 18, 19, 20],
[ 21, 22, 23, 24, 25, 26, 27],
[ 28, 29, 30, 31, 0, 0, 0]
],
"April":[
[ 0, 0, 0, 0, 1, 2, 3],
[ 4, 5, 6, 7, 8, 9, 10],
[11, 12, 13, 14, 15, 16, 17],
[18, 19, 20, 21, 22, 23, 24],
[25, 26, 27, 28, 29, 30, 0]
],
"May":[
[ 0, 0, 0, 0, 0, 0, 1],
[ 2, 3, 4, 5, 6, 7, 8],
[ 9, 10, 11, 12, 13, 14, 15],
[ 16, 17, 18, 19, 20, 21, 22],
[ 23, 24, 25, 26, 27, 28, 29],
[ 30, 31, 0, 0, 0, 0, 0]
],
"June":[
[ 0, 0, 1, 2, 3, 4, 5],
[ 6, 7, 8, 9, 10, 11, 12],
[ 13, 14, 15, 16, 17, 18, 19],
[ 20, 21, 22, 23, 24, 25, 26],
[ 27, 28, 29, 30, 0, 0, 0]
],
"July":[
[ 0, 0, 0, 0, 1, 2, 3],
[ 4, 5, 6, 7, 8, 9, 10],
[ 11, 12, 13, 14, 15, 16, 17],
[ 18, 19, 20, 21, 22, 23, 24],
[ 25, 26, 27, 28, 29, 30, 31]
],
"August":[
[ 1, 2, 3, 4, 5, 6, 7],
[ 8, 9, 10, 11, 12, 13, 14],
[ 15, 16, 17, 18, 19, 20, 21],
[ 22, 23, 24, 25, 26, 27, 28],
[ 29, 30, 31, 0, 0, 0, 0]
],
"September":[
[ 0, 0, 0, 1, 2, 3, 4],
[ 5, 6, 7, 8, 9, 10 ,11],
[ 12 ,13 ,14 ,15 ,16 ,17 ,18],
[ 19 ,20 ,21 ,22 ,23 ,24 ,25],
[ 26 ,27 ,28 ,29 ,30, 0, 0]
],
"October":[
[ 0, 0, 0, 0, 0, 1, 2],
[ 3, 4, 5, 6, 7, 8, 9],
[ 10, 11, 12, 13, 14, 15, 16],
[ 17, 18, 19, 20, 21, 22, 23],
[ 24, 25, 26, 27, 28, 29, 30],
[ 31, 0, 0, 0, 0, 0, 0]
],
"November":[
[ 0, 1, 2, 3, 4, 5, 6],
[ 7, 8, 9, 10, 11, 12, 13],
[ 14, 15, 16, 17, 18, 19, 20],
[ 21, 22, 23, 24, 25, 26, 27],
[ 28, 29, 30, 0, 0, 0, 0]
],
"December":[
[ 0, 0, 0, 1, 2, 3, 4],
[ 5, 6, 7, 8, 9, 10, 11],
[ 12, 13, 14, 15, 16, 17, 18],
[ 19, 20, 21, 22, 23, 24, 25],
[ 26, 27, 28, 29, 30, 31, 0]
]
}
```
---
## Year /fullyear/\
Returns the desired year's complete calendar.
```url
GET https://calendar-json-app.adaptable.app/fullyear/
```
*E.G*
Entering the year 2031 as a parameter
```url
GET https://calendar-json-app.adaptable.app/fullyear/2031
```
the response will be:
```json
{
"year": 2031,
"January":[
[ 0, 0, 0, 1, 2, 3, 4],
[ 5, 6, 7, 8, 9, 10, 11],
[ 12, 13, 14, 15, 16, 17, 18],
[ 19, 20, 21, 22, 23, 24, 25],
[ 26, 27, 28, 29, 30, 31, 0]
],
"February":[
[ 0, 0, 0, 0, 0, 0, 1],
[ 2, 3, 4, 5, 6, 7, 8],
[ 9, 10, 11, 12, 13, 14, 15],
[ 16, 17, 18, 19, 20, 21, 22],
[ 23, 24, 25, 26, 27, 28, 0],
[ 0, 0, 0, 0, 0, 0, 0]
],
"March":[
[ 0, 0, 0, 0, 0, 0, 1],
[ 2, 3, 4, 5, 6, 7, 8],
[ 9, 10, 11, 12, 13, 14, 15],
[ 16, 17, 18, 19, 20, 21, 22],
[ 23, 24, 25, 26, 27, 28, 29],
[ 30, 31, 0, 0, 0, 0, 0]
],
"April":[
[ 0, 0, 1, 2, 3, 4, 5],
[ 6, 7, 8, 9, 10, 11, 12],
[ 13, 14, 15, 16, 17, 18, 19],
[ 20, 21, 22, 23, 24, 25, 26],
[ 27, 28, 29, 30, 0, 0, 0]
],
"May":[
[ 0, 0, 0, 0, 1, 2, 3],
[ 4, 5, 6, 7, 8, 9, 10],
[ 11, 12, 13, 14, 15, 16, 17],
[ 18, 19, 20, 21, 22, 23, 24],
[ 25, 26, 27, 28, 29, 30, 31]
],
"June":[
[ 1, 2, 3, 4, 5, 6, 7],
[ 8, 9, 10, 11, 12, 13, 14],
[ 15, 16, 17, 18, 19, 20, 21],
[ 22, 23, 24, 25, 26, 27, 28],
[ 29, 30, 0, 0, 0, 0, 0]
],
"July":[
[ 0, 0, 1, 2, 3, 4, 5],
[ 6, 7, 8, 9, 10, 11, 12],
[ 13, 14, 15, 16, 17, 18, 19],
[ 20, 21, 22, 23, 24, 25, 26],
[ 27, 28, 29, 30 ,31, 0, 0]
],
"August":[
[ 0, 0, 0, 0, 0, 1, 2],
[ 3, 4, 5, 6, 7, 8, 9],
[ 10, 11, 12, 13, 14, 15, 16],
[ 17, 18, 19, 20, 21, 22, 23],
[ 24, 25, 26, 27, 28, 29, 30],
[ 31, 0, 0, 0, 0, 0, 0]
],
"September":[
[ 0, 1, 2, 3, 4, 5, 6],
[ 7, 8, 9, 10, 11, 12, 13],
[ 14, 15, 16, 17, 18, 19, 20],
[ 21, 22, 23, 24, 25, 26, 27],
[ 28, 29, 30, 0, 0, 0, 0]
],
"October":[
[ 0, 0, 0, 1, 2, 3, 4],
[ 5, 6, 7, 8, 9, 10, 11],
[ 12, 13, 14, 15, 16, 17, 18],
[ 19, 20, 21, 22, 23, 24, 25],
[ 26, 27, 28, 29, 30, 31, 0]
],
"November":[
[ 0, 0, 0, 0, 0, 0, 1],
[ 2, 3, 4, 5, 6, 7, 8],
[ 9, 10, 11, 12, 13, 14, 15],
[ 16, 17, 18, 19, 20, 21, 22],
[ 23, 24, 25, 26, 27, 28, 29],
[ 30, 0, 0, 0, 0, 0, 0]
],
"December":[
[ 0, 1, 2, 3, 4, 5, 6],
[ 7, 8, 9, 10, 11, 12, 13],
[ 14, 15, 16, 17, 18, 19, 20],
[ 21, 22, 23, 24, 25, 26, 27],
[ 28, 29, 30, 31, 0, 0, 0]
]
}
```
---
# Technologies
- Typescript
- Express
- Jest
- Ts node dev
- Super test
- Dotenv
- Http status code
- Eslint
- Swagger
---
# Tests
Developed integration tests, using jest and supertest, for all endpoints
---
# Instructions to start tests locally
- run the command `npm test`
---
# Deployment
Deployment on [Adaptable](https://adaptable.io/)
