Skip to content

Deen-Bridge/dnb-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

162 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

✨ Deen Bridge: Connecting You to Islamic Knowledge πŸ•Œ

A modern platform empowering Muslims with authentic Islamic education through courses, books, spaces and mentorship.

πŸš€ Get Started: Setting Up Your Local Environment

Ready to dive into the Deen Bridge project? Follow these simple steps:

⬇️ Clone the Repository

git clone git@github.com:Deen-Bridge/dnb-frontend.git
cd dnb-frontend

πŸ› οΈ Installation

  • Install dependencies using npm:
npm install
  • Or, install dependencies using yarn:
yarn install

βš™οΈ Configuration

  • Create a .env.local file based on the .env.example
  • Set your environment variables:
NEXT_PUBLIC_API_URL=your_api_endpoint

πŸƒ Run the Development Server

  • Start the development server using npm:
npm run dev
  • Or, start the development server using yarn:
yarn dev

Your application should now be running on http://localhost:3000.

πŸ’‘ Usage

πŸ“š Exploring the Course Library

Detailed Instructions
  1. Navigate to the /dashboard/courses route.
  2. Browse the available courses.
  3. Click on a course to view its details.
  4. Enroll and start learning!

Course Library Screenshot

// Example code snippet
import CourseCard from '@/components/molecules/dashboard/cards/courseCard';

const CoursesTab = () => {
  return (
    //...JSX Code
    <CourseCard key={course.id} course={course} />
    //...JSX Code
  );
};

πŸ“– Reading Books in the Library

Step-by-Step Guide
  1. Go to the /dashboard/library section.
  2. Browse the available Islamic books.
  3. Click on a book to start reading online or download it.

Library Screenshot

// Example code snippet
import LibraryBookCard from '@/components/molecules/dashboard/cards/libraryCard';
const BooksTab = () => {
 return (
    //...JSX Code
     <LibraryBookCard key={book.id} book={book} />
    //...JSX Code
  );
};

✨ Key Features

  • πŸ“š Extensive Library: Access a wide range of Islamic books and resources.
  • πŸŽ“ Interactive Courses: Enroll in courses covering various Islamic topics.
  • πŸ’¬ Community Spaces: Connect with fellow learners in dedicated spaces.
  • πŸ§‘β€πŸ« Expert Mentorship: Learn directly from experienced mentors.
  • πŸ“± Mobile-Friendly: Enjoy a seamless experience on all devices.
  • πŸ”’ Secure Authentication: Safe and secure user authentication.
  • 🎨 Customizable Profiles: Personalize your learning journey.

πŸ› οΈ Technologies Used

Technology Description Link
Next.js React framework for building performant web applications https://nextjs.org/
JavaScript Programming language for web development. https://developer.mozilla.org/en-US/docs/Web/JavaScript
Tailwind CSS CSS framework for designing modern user interfaces https://tailwindcss.com/
Radix UI Set of unstyled UI primitives for building accessible web apps https://www.radix-ui.com/
Zod TypeScript-first schema declaration with static type inference https://zod.dev/
Axios Promise based HTTP client for the browser and node.js https://axios-http.com/
ESLint Tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. https://eslint.org/
React Hook Form Performant, flexible and extensible forms with easy-to-use validation. https://www.react-hook-form.com/
Sonner An opinionated toast component for react. https://sonner.emilkowalski.com/

🀝 Contributing

We welcome contributions to the Deen Bridge project! Here’s how you can help:

  • πŸ› Report Bugs: Submit detailed bug reports to help us improve stability.
  • ✨ Suggest Features: Propose new features to enhance the platform.
  • πŸ‘¨β€πŸ’» Submit Pull Requests: Contribute code fixes and improvements.

Please follow these guidelines:

  • Follow the coding conventions used throughout the project.
  • Write clear, concise, and well-documented code.
  • Submit pull requests with detailed descriptions of the changes.
  • Be respectful and collaborative in discussions and code reviews.

πŸ“œ License

This project is licensed under the MIT License.

πŸ§‘β€πŸ’» Author Info

  • Deen Bridge
    • Website
    • [Twitter](Twitter placeholder)
    • [GitHub](GitHub placeholder)

About

✨ Deen Bridge: Connecting You to Islamic Knowledge πŸ•Œ, A modern platform empowering Muslims with authentic Islamic education through courses, books, spaces and mentorship.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors