mrmezan06/al-quran

Al Quran & Hadith Web Service

• Author: Mejanur Rahman

• Version: 1.0.0

Description

Al-Quran Web Service is a web service that provides access to the full text of the Quran in multiple languages. It is designed to be used by developers and researchers who need access to the Quran in an easy-to-use format.

The Al-Quran Web Service provides access to the full text of the Quran in multiple languages, including Arabic, English, and Bangla. The service also provides access to translations of the Quran into other languages. The service is designed to be used by developers and researchers who need access to the Quran in an easy-to-use format.

The Al-Quran Web Service also provides a web interface that allows users to browse through all of the verses and chapters in the Quran. This interface includes features such as highlighting words or phrases within a verse, searching for specific words or phrases within a verse, and bookmarking verses for later reference.

It is built with React, Redux, Node.js, Express, and MongoDB. It is included several hadiths and its translation.

The Al-Quran Web Service is free and open source software released under an MIT license. The application is deployed on Netlify. The application is live at https://islamic-life.netlify.app/ & back-end running on Render.

Table of Contents

• Installation
• Usage
• Packages
• Live Demo
• Contributing
• License

Installation

To install the application follow the instructions below:

git clone https://github.com/mrmezan06/al-quran.git
cd backend
npm install
npm run server
cd client
npm install --legacy-peer-deps
npm start

Note: The application uses MongoDB as the database. You will need to create a MongoDB database and add the connection string to the .env file. You need to provide some credientials in the .env file. [x] MONGO_URI = "Your MongoDB connection string" [x] PORT = 5000 [x] NODE_ENV = "development"

Live Demo

Packages

Front-end

• axios
• react-bootstrap
• react-router-bootstrap
• react-router-dom
• react-redux
• redux
• redux-devtools-extension
• redux-thunk
• react

Preview

Back-end

• dotenv
• express
• mongoose
• cors
• colors
• devDependencies
  • nodemon

Usage

To use the application follow the instructions below:

npm run dev

It will concurrently run the front-end and back-end server.

Contributing

If you would like to contribute it, you can follow these guidelines for how to do so. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

• (This README was generated with ❤️ by readme-md-generator)