Journey with Quran is a reflective, community-based platform where users can share personal insights, reflections, and inspirations from their Quranic reading. It acts as an open Quran journal — a space for thought, learning, and mutual growth. Alongside reflections, the platform offers access to the Quran, tafsir, and hadith resources to deepen understanding and promote meaningful engagement with the words of Allah ﷻ.
- Post Reflections – Share your personal learnings and thoughts from your Quran reading.
- Quran Integration – Explore and search the Quran with ease.
- Tafsir & Hadith Support – Enrich your understanding with classical commentary and hadith sources.
- Follow System – Connect with other users, follow their journey, and build a reflection-driven community.
- Real-Time Data Updates – Seamless consistency across all posts and profile updates.
- Secure Modular Backend – Scalable backend built for growth and flexibility.
| Layer | Technology |
|---|---|
| Frontend | React, TypeScript |
| Backend | Node.js, Express |
| Database | MongoDB, Mongoose |
| Language | TypeScript |
| Tools | Git, VS Code, Postman |
journey-with-quran/
├── frontend-v2/ # React frontend
│ └── src/
│ ├── components/
│ ├── pages/
│ └── utils/
├── backend/ # Express backend
│ ├── controllers/
│ ├── models/
│ ├── routes/
│ └── middlewares/
└── README.md
- Node.js (v16+ recommended)
- MongoDB
- Git
-
Clone the repository
git clone https://github.com/Mehedi-bit/journey-with-quran.git cd journey-with-quran -
Install dependencies
# Backend cd backend npm install # Frontend cd ../frontend-v2 npm install
-
Environment setup
Create
.envfiles inbackend/with the necessary keys.Backend
.envexample:PORT=5000 MONGO_URI=your_mongodb_uri JWT_SECRET=your_jwt_secret CLOUDINARY_CLOUD_NAME=your_cloudinary_name CLOUDINARY_API_KEY=your_cloudinary_api_key CLOUDINARY_API_SECRET=your_cloudinary_api_secret NODE_ENV=development
-
Run development servers
# Start backend server cd backend npm run dev # Start frontend server (in a new terminal) cd ../frontend-v2 npm run dev
- Atomic Updates: MongoDB transactions used for critical operations like follow/unfollow.
- Auto Propagation: Profile changes automatically update across all posts and replies.
- Efficient Bulk Operations: Handles large-scale data changes without compromising performance.
- Robust Error Handling: Ensures stability and reliability during all critical flows.
We welcome your contributions!
- Fork the repository
- Create a feature branch (
git checkout -b feature-name) - Make your changes
- Commit your code (
git commit -m "Add feature") - Push to the branch (
git push origin feature-name) - Create a Pull Request
Please follow clean code principles and include helpful comments.
To everyone exploring the Quran and sharing their reflections — may this platform be a means of continuous benefit and reward.