xoventechdev / Quran-API

This project provides a RESTful API service for retrieving information about Quranic verses in multiple languages. It includes endpoints to fetch information about all Surahs as well as specific Surahs by their IDs.

Quran RESTful API with Express.js and Mysql

This project provides a RESTful API service for retrieving information about Quranic verses in multiple languages. It includes endpoints to fetch information about all Surahs as well as specific Surahs by their IDs.

Live Url : https://quran.netwix.xyz/api/v1/surah : Retrieve information about all Surahs.

Live Url : https://quran.netwix.xyz/api/v1/surah/1 : Retrieve information about a specific Surah by its ID.

Usage

Endpoints

• GET /api/v1/surah: Retrieve information about all Surahs.
• GET /api/v1/surah/:id: Retrieve information about a specific Surah by its ID.

Response Format

The API responses are formatted in JSON and include the following fields:

• status: Indicates the status of the request (success or error).
• data: Contains the requested data if the request is successful.
• message: Provides additional information about the response, especially in case of errors.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/quran-api-service.git
   

2. Install dependencies:

   cd your-repository
   npm install
   

3. Start the server:

   npm start
   

4. Open your browser and go to http://localhost:3333.

Dependencies

• Express: Express
• MySql: MySql

Contributing

Feel free to contribute by opening issues or submitting pull requests.

License

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