Skip to content

Commit 9f6e1f3

Browse files
committed
updated README.md
1 parent 763067b commit 9f6e1f3

1 file changed

Lines changed: 109 additions & 7 deletions

File tree

README.md

Lines changed: 109 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,111 @@
1-
<h2>Features</h2>
1+
# Scriptures React Project
22

3-
<ol>
4-
<li>Read whole Quran in organized way.</li>
5-
<li>Find hundreds of translations for each verse.</li>
6-
<li>Add your own translation for any verse.</li>
7-
<li>User Authentication System.</li>
8-
</ol>
3+
[![Read on Substack](https://img.shields.io/badge/Substack-Read%20Article-orange)](https://substack.com/home/post/p-169357406)
94

5+
A full-stack platform for browsing, searching, and contributing translations of user-preferred books.
6+
7+
Built with React.js, Express.js, and MongoDB, **Scriptures** provides a responsive interface for verse-by-verse navigation, unified search, and user-contributed translations. The project currently integrates Quran.com APIs for accurate translations and metadata, with future versions planned for multi-book support.
8+
9+
---
10+
11+
## Features
12+
13+
* 📖 Read the Quran in an organized way
14+
* 🌐 Access hundreds of translations for each verse
15+
* ✍️ Add your own translation for any verse
16+
* 🔒 User authentication system
17+
18+
---
19+
20+
## Live Demo
21+
22+
https://scriptures-react-project.vercel.app/
23+
24+
---
25+
26+
## Backend Repository
27+
28+
https://github.com/Waheed-Labib/Scriptures_express_server
29+
30+
---
31+
32+
## Tech Stack
33+
34+
* **Frontend:** React.js, Tailwind CSS, Context API, React Router DOM, Axios, React Helmet
35+
* **Backend:** Express.js, MongoDB (Mongoose)
36+
* **Authentication & Security:** JWT, bcrypt
37+
* **Email Services:** Nodemailer
38+
* **Utilities:** dotenv, DOMPurify
39+
40+
---
41+
42+
## Requirements
43+
44+
* Node.js (>= 18)
45+
* npm or yarn
46+
* MongoDB instance (local or cloud)
47+
48+
---
49+
50+
## Installation
51+
52+
1. Clone the repository:
53+
54+
```bash
55+
git clone https://github.com/Waheed-Labib/Scriptures_React_Project.git
56+
cd Scriptures_React_Project
57+
```
58+
59+
2. Install dependencies:
60+
61+
```bash
62+
npm install
63+
```
64+
65+
---
66+
67+
## Running the Project
68+
69+
### Frontend (React)
70+
71+
```bash
72+
npm start
73+
```
74+
75+
The app will run at `http://localhost:5173/`.
76+
77+
### Backend (Express)
78+
79+
Clone and set up the backend repo: [Scriptures Express Server](https://github.com/Waheed-Labib/Scriptures_express_server)
80+
81+
```bash
82+
npm run dev
83+
```
84+
85+
---
86+
87+
## Roadmap / Future Versions
88+
89+
1. Add more books
90+
2. Allow users to upload books
91+
3. Provide dev options for book APIs
92+
4. Add discussion panel on each verse
93+
94+
---
95+
96+
## Contributing
97+
98+
Contributions are welcome! Please fork the repository and create a pull request with detailed information.
99+
100+
---
101+
102+
## Resources & Articles
103+
104+
* [Project Overview on Substack](https://substack.com/home/post/p-169357406)
105+
106+
---
107+
108+
## Acknowledgements
109+
110+
* [Quran.com APIs](https://quran.com/) for translations and metadata
111+
* Open source libraries and contributors

0 commit comments

Comments
 (0)