Skip to content

Commit 2dfe127

Browse files
HouariZegaiHouariZegai
committed
refactor: improve UI
1 parent f59e822 commit 2dfe127

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1802
-677
lines changed

‎.editorconfig

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
indent_style = space
8+
indent_size = 2
9+
trim_trailing_whitespace = true
10+
end_of_line = lf
11+
insert_final_newline = true

‎.eslintignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules/
2+
package-lock.json
3+
dist/
4+
coverage
5+
src/components/ui/*

‎.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

‎.github/ISSUE_TEMPLATE/bug.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug
3+
about: Report a bug to help improve the project
4+
labels: bug
5+
assignees:
6+
---
7+
8+
## **Description**
9+
10+
A clear and concise description of the bug.
11+
12+
## **Steps to Reproduce**
13+
14+
1. Step 1
15+
2. Step 2
16+
17+
## **Expected Behavior**
18+
19+
What should happen instead?
20+
21+
## **Actual Behavior**
22+
23+
What is happening instead?
24+
25+
## **Environment**
26+
27+
- OS: [e.g., Windows, Mac, Linux]
28+
- Browser (if applicable): [e.g., Chrome, Firefox]
29+
- Version: [e.g., 1.0.0]
30+
31+
## **Additional Context**
32+
33+
Any extra information, logs, or screenshots that might help.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Need Support?
4+
url: https://github.com/yaqiin/yaqiin-quran/discussions
5+
about: Please ask and answer questions in Discussions instead of opening an issue.

‎.github/ISSUE_TEMPLATE/feature.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature
3+
about: Describe the feature that needs to be implemented
4+
labels: feature
5+
assignees:
6+
---
7+
8+
## **Description**
9+
10+
A clear and concise description of the feature.
11+
12+
## **Acceptance Criteria**
13+
14+
- [ ] Criteria 1
15+
- [ ] Criteria 2

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Description
2+
3+
Please provide a summary of the changes you made and the reason for the change.
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Code enhancement
10+
- [ ] Documentation update
11+
12+
## Checklist
13+
14+
- [ ] I have tested my changes locally
15+
- [ ] My code follows the project's coding style

‎.github/workflows/preview.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Preview Deploy to Vercel
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
build_and_deploy:
8+
runs-on: ubuntu-latest
9+
permissions:
10+
contents: write
11+
pull-requests: write
12+
repository-projects: write
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: amondnet/vercel-action@v20
16+
id: vercel-deploy
17+
with:
18+
vercel-token: ${{ secrets.VERCEL_TOKEN }}
19+
github-token: ${{ secrets.GITHUB_TOKEN }}
20+
vercel-org-id: ${{ secrets.ORG_ID }}
21+
vercel-project-id: ${{ secrets.PROJECT_ID }}
22+
- name: preview-url
23+
run: |
24+
echo ${{ steps.vercel-deploy.outputs.preview-url }}

‎.github/workflows/release.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Release Deploy to Vercel
2+
on:
3+
push:
4+
tags:
5+
- 'v*'
6+
jobs:
7+
build_and_deploy:
8+
runs-on: ubuntu-latest
9+
permissions:
10+
contents: write
11+
pull-requests: write
12+
repository-projects: write
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: amondnet/vercel-action@v20
16+
with:
17+
vercel-token: ${{ secrets.VERCEL_TOKEN }}
18+
github-token: ${{ secrets.GITHUB_TOKEN }}
19+
vercel-args: '--prod'
20+
vercel-org-id: ${{ secrets.ORG_ID}}
21+
vercel-project-id: ${{ secrets.PROJECT_ID}}

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ dist-ssr
2222
*.njsproj
2323
*.sln
2424
*.sw?
25+
.vercel

‎.husky/pre-commit

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/bin/sh
2+
3+
echo "🧹 Running Prettier & ESLint on staged files..."
4+
5+
npx lint-staged
6+
7+
RESULT=$?
8+
9+
if [ $RESULT -ne 0 ]; then
10+
echo "❌ Commit aborted due to lint errors or formatting issues."
11+
exit 1
12+
else
13+
echo "✅ All good! Proceeding with commit."
14+
fi

‎.husky/pre-push

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/bin/sh
2+
3+
echo "🔍 Running TypeScript type check..."
4+
5+
npm run typecheck
6+
7+
RESULT=$?
8+
9+
if [ $RESULT -ne 0 ]; then
10+
echo "❌ Push aborted due to TypeScript errors."
11+
exit 1
12+
else
13+
echo "✅ No TypeScript errors. Proceeding with push."
14+
fi

‎.prettierignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules
2+
dist
3+
build
4+
coverage
5+
src/components/ui/*

‎.prettierrc.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"printWidth": 120,
3+
"tabWidth": 2,
4+
"useTabs": false,
5+
"semi": true,
6+
"singleQuote": true,
7+
"jsxSingleQuote": false,
8+
"trailingComma": "all",
9+
"bracketSpacing": true,
10+
"bracketSameLine": false,
11+
"arrowParens": "always",
12+
"endOfLine": "lf",
13+
"overrides": [
14+
{
15+
"files": "*.md",
16+
"options": {
17+
"printWidth": 80,
18+
"proseWrap": "always"
19+
}
20+
},
21+
{
22+
"files": "*.{ts,tsx}",
23+
"options": {
24+
"parser": "typescript"
25+
}
26+
}
27+
],
28+
"plugins": ["prettier-plugin-tailwindcss"]
29+
}

‎CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contribution Guidelines
2+
3+
Thank you for helping improve this project! Choose how you'd like to contribute:
4+
5+
## 🐛 Report bugs
6+
7+
- Check existing [issues](https://github.com/yaqiin/yaqiin-quran/issues) first
8+
- Open a new issue if it's not reported yet
9+
- Include steps to reproduce the bug
10+
11+
## 💡 Suggest Improvements
12+
13+
- Open an [issue](https://github.com/yaqiin/yaqiin-quran/issues) to discuss
14+
your idea
15+
- We will let you know if it fits the project
16+
17+
## 🛠️ Development
18+
19+
All pull requests need review before merging. We appreciate your help!
20+
21+
Here's how to get started:
22+
23+
- Find an issue to work on (or start a new one)
24+
- Fork the repo and make your changes
25+
- Open a [pull request](https://github.com/yaqiin/yaqiin-quran/pulls) with:
26+
- Description of your changes
27+
- Links to any related issues
28+
29+
### 🚀 Code Contributions
30+
31+
- Refactor/Improve existing code
32+
- Add new feature
33+
- Fix bugs
34+

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Yaqiin
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 19 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,41 @@
1-
# Welcome to your Lovable project
1+
# القرآن الكريم
22

3-
## Project info
3+
منصة تفاعلية لقراءة القرآن الكريم عبر الإنترنت، تهدف إلى توفير تجربة سلسة وسريعة للمستخدمين.
44

5-
**URL**: https://lovable.dev/projects/e3488ef9-8779-489a-a016-3bfa1e3ebeaf
5+
## البدء
66

7-
## How can I edit this code?
8-
9-
There are several ways of editing your application.
10-
11-
**Use Lovable**
12-
13-
Simply visit the [Lovable Project](https://lovable.dev/projects/e3488ef9-8779-489a-a016-3bfa1e3ebeaf) and start prompting.
14-
15-
Changes made via Lovable will be committed automatically to this repo.
16-
17-
**Use your preferred IDE**
18-
19-
If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in Lovable.
20-
21-
The only requirement is having Node.js & npm installed - [install with nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
22-
23-
Follow these steps:
7+
### تشغيل المشروع على جهازك المحلي
248

259
```sh
26-
# Step 1: Clone the repository using the project's Git URL.
27-
git clone <YOUR_GIT_URL>
10+
# استنساخ المستودع من GitHub.
11+
git clone https://github.com/yaqiin/yaqiin-quran.git
2812

29-
# Step 2: Navigate to the project directory.
30-
cd <YOUR_PROJECT_NAME>
13+
# الانتقال إلى مجلد المشروع.
14+
cd yaqiin-quran
3115

32-
# Step 3: Install the necessary dependencies.
16+
# تثبيت جميع التبعيات المطلوبة.
3317
npm i
3418

35-
# Step 4: Start the development server with auto-reloading and an instant preview.
19+
# تشغيل خادم التطوير مع إعادة تحميل تلقائية ومعاينة فورية.
3620
npm run dev
3721
```
3822

39-
**Edit a file directly in GitHub**
40-
41-
- Navigate to the desired file(s).
42-
- Click the "Edit" button (pencil icon) at the top right of the file view.
43-
- Make your changes and commit the changes.
44-
45-
**Use GitHub Codespaces**
46-
47-
- Navigate to the main page of your repository.
48-
- Click on the "Code" button (green button) near the top right.
49-
- Select the "Codespaces" tab.
50-
- Click on "New codespace" to launch a new Codespace environment.
51-
- Edit files directly within the Codespace and commit and push your changes once you're done.
52-
53-
## What technologies are used for this project?
54-
55-
This project is built with:
23+
### التقنيات المستخدمة
24+
تم بناء المشروع باستخدام مجموعة من أحدث التقنيات، بما في ذلك:
5625

5726
- Vite
5827
- TypeScript
5928
- React
6029
- shadcn-ui
6130
- Tailwind CSS
31+
- GitHub Actions
6232

63-
## How can I deploy this project?
64-
65-
Simply open [Lovable](https://lovable.dev/projects/e3488ef9-8779-489a-a016-3bfa1e3ebeaf) and click on Share -> Publish.
66-
67-
## Can I connect a custom domain to my Lovable project?
33+
## إرشادات المساهمة
6834

69-
Yes, you can!
35+
نرحب بجميع المساهمات في هذا المشروع!
36+
للمزيد من التفاصيل حول كيفية المساهمة، يُرجى الاطلاع على ملف
37+
[CONTRIBUTING.md](CONTRIBUTING.md).
7038

71-
To connect a domain, navigate to Project > Settings > Domains and click Connect Domain.
39+
## الرخصة
7240

73-
Read more here: [Setting up a custom domain](https://docs.lovable.dev/tips-tricks/custom-domain#step-by-step-guide)
41+
هذا المشروع مرخّص بموجب رخصة MIT. راجع ملف [LICENSE](LICENSE) للمزيد من التفاصيل.

‎components.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@
1717
"lib": "@/lib",
1818
"hooks": "@/hooks"
1919
}
20-
}
20+
}

0 commit comments

Comments
 (0)