Deen and Dunya

Welcome to the Deen and Dunya project! This website aims to guide the Ummah and help solve existential crises by providing valuable resources on Islam, mental health, and physical wellness.

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Contributing
• License
• Contact

Introduction

Deen and Dunya is a platform designed to offer free resources and guidance for Muslims. It focuses on balancing religious (Deen) and worldly (Dunya) aspects of life to help individuals find purpose and improve their mental and physical well-being.

Features

• Islamic Literature: Access to a vast library of free Islamic texts.
• Existence Project: Discussions on the purpose of life from an Islamic perspective.
• Technical Skills: Resources and tutorials to enhance your professional skills.
• Physical Fitness: Tips and articles on maintaining physical health.
• Mental Wellness: Strategies and advice for mental well-being.

Installation

To run the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/yasirfaizahmed/orbiting-thoughts.git
   cd orbiting-thoughts

2. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install dependencies:

   pip install -r requirements.txt

4. Set up the database:

   alembic upgrade head  # If using Alembic for migrations

5. Run the application:

   uvicorn main:app --reload

Usage

To use the Deen and Dunya website:

1. Open your web browser and navigate to http://localhost:8000.
2. Explore the various sections: Islamic Literature, Existence Project, Technical Skills, Physical Fitness, and Mental Wellness.
3. Use the search functionality to find specific resources or articles.

Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/YourFeatureName

3. Make your changes and commit them:

   git commit -m 'Add some feature'

4. Push to the branch:

   git push origin feature/YourFeatureName

5. Open a pull request.

Please ensure your code follows the project's coding standards and includes appropriate tests.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

For questions or feedback, please contact us at:

• Email: [email protected]