A modern platform empowering Muslims with authentic Islamic education through courses, books, spaces and mentorship.
Ready to dive into the Deen Bridge project? Follow these simple steps:
git clone git@github.com:Deen-Bridge/dnb-frontend.git
cd dnb-frontend- Install dependencies using
npm:
npm install- Or, install dependencies using
yarn:
yarn install- Create a
.env.localfile based on the.env.example - Set your environment variables:
NEXT_PUBLIC_API_URL=your_api_endpoint- Start the development server using
npm:
npm run dev- Or, start the development server using
yarn:
yarn devYour application should now be running on http://localhost:3000.
Detailed Instructions
- Navigate to the
/dashboard/coursesroute. - Browse the available courses.
- Click on a course to view its details.
- Enroll and start learning!
// Example code snippet
import CourseCard from '@/components/molecules/dashboard/cards/courseCard';
const CoursesTab = () => {
return (
//...JSX Code
<CourseCard key={course.id} course={course} />
//...JSX Code
);
};Step-by-Step Guide
- Go to the
/dashboard/librarysection. - Browse the available Islamic books.
- Click on a book to start reading online or download it.
// Example code snippet
import LibraryBookCard from '@/components/molecules/dashboard/cards/libraryCard';
const BooksTab = () => {
return (
//...JSX Code
<LibraryBookCard key={book.id} book={book} />
//...JSX Code
);
};- π 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.
| 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/ |
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.
This project is licensed under the MIT License.
- Deen Bridge
- Website
- [Twitter](Twitter placeholder)
- [GitHub](GitHub placeholder)
