https://github.com/mskian/thirukkural-api

Thirukkural JSON API Build using Express API Server.
https://github.com/mskian/thirukkural-api

api express expressjs json tamil tamil-sms tamilnadu tamilsms thirukkural thirukural

Last synced: 22 days ago
JSON representation

Thirukkural JSON API Build using Express API Server.

• Host: GitHub
• URL: https://github.com/mskian/thirukkural-api
• Owner: mskian
• License: mit
• Created: 2022-02-23T11:18:16.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-11T16:36:50.000Z (over 2 years ago)
• Last Synced: 2024-11-07T22:48:42.568Z (2 months ago)
• Topics: api, express, expressjs, json, tamil, tamil-sms, tamilnadu, tamilsms, thirukkural, thirukural
• Language: JavaScript
• Homepage:
• Size: 552 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Thirukkural API

![build-test](https://github.com/mskian/thirukkural-api/workflows/build-test/badge.svg)  

Thirukkural JSON API Build using Express API Server.

> Better self Host this API Service for 100% Uptime

```sh

http://localhost:4001/ - # Get Random Kural

http://localhost:4001/<1 to 1330> # http://localhost:4001/25 - Get Kural by No

```

## API Data 🍘

Tirukkuṛaḷ Data From - [@tk120404/thirukkural](https://github.com/tk120404/thirukkural)

## Features ✨

- Express for API server

- CORS Headers for API Restriction

- API Cache Module for Caching the API data `app.get('/:id', cache('1 hour')`

## usage 📝

- Clone or Download this Repo

- install dependencies

```sh

yarn

```

- Development

```sh

yarn dev

```

- Production

```sh

yarn start

```

## LICENSE ✅

MIT