https://github.com/stanleyy7/psalmapi
A REST API of Pslams. Created as I was wanting to create a website that displays a random psalm upon open. However, there was no such API. So, I made my own. Please let me know if there are any errors/bugs you encounter.
https://github.com/stanleyy7/psalmapi
javascript jest-tests nodejs rest-api
Last synced: 2 months ago
JSON representation
A REST API of Pslams. Created as I was wanting to create a website that displays a random psalm upon open. However, there was no such API. So, I made my own. Please let me know if there are any errors/bugs you encounter.
- Host: GitHub
- URL: https://github.com/stanleyy7/psalmapi
- Owner: StanleyY7
- License: mit
- Created: 2023-05-20T06:20:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-09T20:32:34.000Z (about 1 year ago)
- Last Synced: 2024-04-10T00:40:01.067Z (about 1 year ago)
- Topics: javascript, jest-tests, nodejs, rest-api
- Language: JavaScript
- Homepage:
- Size: 6.06 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Psalms API {Work In Progress}
### The World's 1st Psalms API (to my knowledge)
#### Overview
A REST API of Pslams. Created as I was wanting to create a website that displays a random psalm upon open. However, there was no such API. So, I made my own. Please let me know if there are any errors/bugs you encounter. Currently 10 out of 150 psalms completed.
Deployed Link: https://restless-feather-6525.fly.dev/psalms
There is also a GraphQL version (REST API wrapped as GraphQL via Apollo Server): https://falling-frost-8420.fly.dev/ (github repo link: https://github.com/StanleyY7/psalmsGraphQL)
(Frontend in progress/development)
#### Design
- Designed for ease of use, it is RESTful for this reason. Only one endpoint /psalms too. Only one GET all request to access all the psalm data.
- The schema consists of an id as the primary key (id is also the Psalm number, i.e. Psalm 1 is id 1), verse which is an array of verses (first index (0) of verse array is "", so accurate to the verses in the Book of Psalms too, i.e. Psalm 2 (id 2), verse[3] would be equal to: "Let us break their chains and throw off their shackles." and version (the translation type of the Bible I have used for it) currently is only "NIV" (I may add more versions such as King James, original Hebrew with translation tool later on).
This will be the design for the frontend
### Tech Stack
- NodeJs
- JavaScript
- Jest