Skip to content

Commit 1cda599

Browse files
Initial commit
0 parents  commit 1cda599

File tree

123 files changed

+39198
-0
lines changed

Some content is hidden

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

123 files changed

+39198
-0
lines changed

.dockerignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
node_modules
2+
npm-debug.log
3+
Dockerfile
4+
.dockerignore
5+
.git
6+
.gitignore
7+
.next/cache

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Universal CODEOWNERS file
2+
shadilrayyan2@gmail.com

.github/CODE_OF_CONDUCT.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official email address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Contributing to the Project
2+
3+
Thank you for your interest in contributing to this Next.js open-source project! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more. Please read the following guidelines to ensure a smooth and collaborative contribution process.
4+
5+
## 📌 Getting Started
6+
7+
### 🔹 Fork and Clone the Repository
8+
1. **Fork** the repository on GitHub.
9+
2. **Clone** your fork to your local machine:
10+
```sh
11+
git clone https://github.com/your-username/your-project.git
12+
```
13+
3. Navigate into the project directory:
14+
```sh
15+
cd your-project
16+
```
17+
4. Add the upstream repository:
18+
```sh
19+
git remote add upstream https://github.com/original-author/your-project.git
20+
```
21+
5. Ensure your fork is up to date with the upstream repository:
22+
```sh
23+
git pull upstream main
24+
```
25+
26+
### 🔹 Install Dependencies
27+
Ensure you have **Node.js (LTS)** and **npm** or **yarn** installed, then install project dependencies:
28+
```sh
29+
npm install
30+
# or
31+
yarn install
32+
```
33+
34+
### 🔹 Running the Project Locally
35+
Start the development server:
36+
```sh
37+
npm run dev
38+
# or
39+
yarn dev
40+
```
41+
Visit `http://localhost:3000` to see the project running.
42+
43+
## 🚀 Contribution Workflow
44+
45+
### 🔹 Reporting Issues
46+
Before opening an issue, check the [existing issues](https://github.com/original-author/your-project/issues) to avoid duplicates.
47+
If you find a bug, experience a performance issue, or have a feature request:
48+
1. Open a **new issue** with a clear and concise description.
49+
2. Provide **steps to reproduce** the issue if applicable.
50+
3. Suggest possible fixes or improvements if you have any ideas.
51+
52+
### 🔹 Submitting Pull Requests (PRs)
53+
1. **Create a new branch** from `main`:
54+
```sh
55+
git checkout -b feature/your-feature
56+
```
57+
2. Implement your changes following the project’s coding standards.
58+
3. **Run tests** to ensure everything is working correctly:
59+
```sh
60+
npm run test
61+
```
62+
4. **Commit your changes** with a meaningful commit message:
63+
```sh
64+
git commit -m "feat: add new feature"
65+
```
66+
5. **Push your branch** to GitHub:
67+
```sh
68+
git push origin feature/your-feature
69+
```
70+
6. **Open a Pull Request (PR)** and provide a clear description of your changes.
71+
7. Address any feedback from maintainers and update your PR if necessary.
72+
73+
## 📏 Code Guidelines
74+
75+
### 🔹 Code Style
76+
- Follow **Next.js best practices**.
77+
- Write **clean, modular, and maintainable code**.
78+
- Use **ESLint and Prettier** to ensure consistent formatting:
79+
```sh
80+
npm run lint
81+
```
82+
83+
### 🔹 Commit Message Convention
84+
Use [Conventional Commits](https://www.conventionalcommits.org/):
85+
```
86+
type(scope): message
87+
```
88+
Examples:
89+
- `feat(auth): add login functionality`
90+
- `fix(ui): resolve navbar bug`
91+
92+
### 🔹 Branch Naming Convention
93+
Follow a structured naming convention for branches:
94+
- **Features:** `feature/your-feature-name`
95+
- **Bug Fixes:** `fix/your-bug-fix`
96+
- **Documentation Updates:** `docs/update-docs`
97+
98+
## 🤝 Community Guidelines
99+
- Be **respectful** and **inclusive**.
100+
- Keep discussions **constructive** and **helpful**.
101+
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md) (if applicable).
102+
103+
## 💡 Need Help?
104+
Join the discussions in GitHub issues or reach out to the maintainers.
105+
106+
We appreciate your contributions! 🚀
107+
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Bug Report
2+
3+
description: Report an issue encountered while using the software.
4+
5+
labels:
6+
- kind/bug
7+
8+
body:
9+
- type: textarea
10+
id: problem
11+
attributes:
12+
label: What happened?
13+
description: |
14+
Describe the issue you encountered in detail. Providing clear and concise information helps in addressing the issue faster.
15+
If this is a security-related issue, please disclose it privately via the appropriate security channels (if applicable).
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: expected
21+
attributes:
22+
label: What did you expect to happen?
23+
description: Explain the behavior you expected from the software.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: repro
29+
attributes:
30+
label: Steps to Reproduce
31+
description: Provide the steps to reproduce the issue as minimally and precisely as possible.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: softwareVersion
37+
attributes:
38+
label: Software Version
39+
description: |
40+
Specify the version of the software where you encountered this issue. If applicable, provide details on the branch, build, or release version.
41+
42+
- type: textarea
43+
id: environment
44+
attributes:
45+
label: Environment Details
46+
description: |
47+
Provide details about the environment where this issue occurred. This could include operating system, platform, cloud provider, or any other relevant context.
48+
value: |
49+
<details>
50+
51+
```console
52+
# On Linux/MacOS:
53+
$ uname -a
54+
$ cat /etc/os-release
55+
# paste output here
56+
57+
# On Windows:
58+
C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture
59+
# paste output here
60+
```
61+
62+
</details>
63+
64+
- type: textarea
65+
id: installTools
66+
attributes:
67+
label: Installation Method
68+
description: Specify the installation tools or package managers used (if applicable).
69+
70+
- type: textarea
71+
id: dependencies
72+
attributes:
73+
label: Related Dependencies or Plugins
74+
description: |
75+
List any plugins, modules, or dependencies (and their versions) that might relate to this issue.
76+
value: |
77+
<details>
78+
79+
</details>
80+
81+
- type: textarea
82+
id: logs
83+
attributes:
84+
label: Logs, Errors, or Debugging Output
85+
description: |
86+
Provide any relevant logs, stack traces, or debugging output that can help diagnose the issue.
87+
value: |
88+
<details>
89+
90+
```console
91+
# Paste logs or errors here.
92+
```
93+
94+
</details>
95+
96+
- type: textarea
97+
id: additional
98+
attributes:
99+
label: Additional Context
100+
description: Include any other details that might help diagnose the issue.

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
contact_links:
2+
- name: Support Request
3+
url: shadilrayyan2@gmail.com

0 commit comments

Comments
 (0)