Skip to content

Commit ba5598b

Browse files
author
Christian Furr
committed
hehe readme
1 parent cc794ee commit ba5598b

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Daily Book of Mormon API
2+
3+
A simple and efficient API for accessing Book of Mormon verses, providing daily verses, random verses, and specific verse lookups.
4+
5+
## Features
6+
7+
- 📖 Daily Verse - Get a new verse every day
8+
- 🎲 Random Verse - Get a random verse from the Book of Mormon
9+
- 🔍 Specific Verse Lookup - Get verses by book, chapter, and verse number
10+
- 📚 Book List - Get a list of all available books and their chapters
11+
12+
## API Endpoints
13+
14+
### Get Daily Verse
15+
```
16+
GET /daily
17+
```
18+
Returns a different verse each day, cycling through all verses.
19+
20+
### Get Random Verse
21+
```
22+
GET /random
23+
```
24+
Returns a random verse from the Book of Mormon.
25+
26+
### Get Specific Verse
27+
```
28+
GET /:book/:chapter/:verse
29+
```
30+
Example: `/nephi1/3/7`
31+
32+
Note: For books of Nephi, you can use the following formats:
33+
- `nephi1` or `1nephi` for 1 Nephi
34+
- `nephi2` or `2nephi` for 2 Nephi
35+
- `nephi3` or `3nephi` for 3 Nephi
36+
- `nephi4` or `4nephi` for 4 Nephi
37+
38+
### Get Available Books
39+
```
40+
GET /books
41+
```
42+
Returns a list of all available books and their chapter counts.
43+
44+
## Installation
45+
46+
1. Clone the repository
47+
2. Install dependencies:
48+
```bash
49+
npm install
50+
```
51+
3. Start the server:
52+
```bash
53+
npm start
54+
```
55+
56+
The server will run on port 3000 by default. You can change this by setting the `PORT` environment variable.
57+
58+
## Development
59+
60+
To run the server in development mode with auto-reload:
61+
```bash
62+
npm run dev
63+
```
64+
65+
## Technologies Used
66+
67+
- Node.js
68+
- Express.js
69+
- CORS
70+
71+
## Creator
72+
73+
Created by Christian Furr ([@MakashiDev](https://github.com/MakashiDev))
74+
75+
## License
76+
77+
This project is open source and available under the MIT License.

0 commit comments

Comments
 (0)