https://github.com/hellofaizan/alquran
https://github.com/hellofaizan/alquran
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hellofaizan/alquran
- Owner: hellofaizan
- Created: 2024-03-15T08:25:46.000Z (over 2 years ago)
- Default Branch: appRoute
- Last Pushed: 2025-06-02T06:33:16.000Z (about 1 year ago)
- Last Synced: 2025-06-02T17:19:04.432Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://alquran-seven.vercel.app
- Size: 4.44 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Al-Quran Web Application
A modern, feature-rich web application built with Next.js for exploring and studying the Quran. This application provides a beautiful and intuitive interface for reading and understanding the Holy Quran.
## 🚀 Features
- Modern, responsive UI built with Next.js and Tailwind CSS
- Dark/Light theme support using next-themes
- Beautiful UI components using Radix UI
- Type-safe development with TypeScript
- Optimized performance with Turbopack
- SEO-friendly with built-in metadata support
- Server-side rendering for better performance and SEO
## 🛠️ Tech Stack
- **Framework:** Next.js 15.3.1
- **Language:** TypeScript 5.1.6
- **Styling:** Tailwind CSS 3.3.3
- **UI Components:** Radix UI
- **Icons:** Lucide React & React Icons
- **State Management:** React Hooks
- **HTTP Client:** Axios
- **Development:** Turbopack for faster development experience
## 📋 Prerequisites
- Node.js >= 20
- Yarn or npm package manager
## 🚀 Getting Started
1. Clone the repository:
```bash
git clone [repository-url]
cd alquran
```
2. Install dependencies:
```bash
yarn install
# or
npm install
```
3. Run the development server:
```bash
yarn dev
# or
npm run dev
```
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## 📁 Project Structure
```
alquran/
├── app/ # Next.js app directory
│ ├── (pages)/ # Application pages
│ ├── (backend)/ # Backend API routes
│ └── utils/ # Utility functions
├── components/ # Reusable React components
├── hooks/ # Custom React hooks
├── lib/ # Library code and configurations
├── public/ # Static assets
└── styles/ # Global styles and Tailwind config
```
## 🛠️ Available Scripts
- `yarn dev` - Start development server with Turbopack
- `yarn build` - Build the application for production
- `yarn start` - Start the production server
- `yarn lint` - Run ESLint for code linting
## 🔧 Configuration
The project uses several configuration files:
- `next.config.js` - Next.js configuration
- `tailwind.config.ts` - Tailwind CSS configuration
- `tsconfig.json` - TypeScript configuration
- `.eslintrc.json` - ESLint configuration
## 📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
## 📫 Contact
For any questions or suggestions, please open an issue in the repository.