Skip to content

Commit bad2272

Browse files
committed
Frontend Template
2 parents ac5923e + 3e2a301 commit bad2272

129 files changed

Lines changed: 3508 additions & 0 deletions

File tree

Some content is hidden

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

.github/CODEOWNERS

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.github/ @AttAditya
2+
ci/ @AttAditya
3+
scripts/ @AttAditya
4+
.gitignore @AttAditya
5+
dev.sh @AttAditya
6+
config.sh @AttAditya
7+
LICENSE @AttAditya
8+

.github/CODE_OF_CONDUCT.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Code of Conduct
2+
3+
## Our Standards
4+
- Be respectful and inclusive
5+
- Accept constructive feedback
6+
- Focus on what is best for the community
7+
8+
## Unacceptable Behavior
9+
- Harassment, trolling, or personal attacks
10+
- Discrimination of any kind
11+
- Publishing private information without consent
12+
13+
## Enforcement
14+
Project maintainers may remove or edit content and take action against contributors who violate these rules.
15+
16+
## Reporting
17+
Report issues to: [attachment.aditya@gmail.com](mailto:attachment.aditya@gmail.com)
18+

.github/CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contribution Guidelines
2+
3+
## Prerequisites
4+
5+
This ecosystem relies on the following tools and libraries:
6+
- Node.js and npm
7+
8+
9+
## Getting Started
10+
11+
Contributions to the ecosystem are welcome and encouraged! Here's how you can get started:
12+
13+
- Fork the repository
14+
- Clone your forked repository
15+
- Create a new branch
16+
- `feat/<feature-name>` for new features
17+
- `fix/<issue-name>` for bug fixes
18+
- `docs/<topic>` for documentation updates
19+
- Make your changes
20+
- Commit your changes
21+
- Add a message that explains the commit
22+
- Preferably, make small and focused commits
23+
- Make as many commits as you need, as long as sensible
24+
- Avoid weird messages like "stuff" (it's reserved for [AttAditya](https://github.com/AttAditya) only, since he's the only one maintaining the repository and can understand what "stuff" means since he wrote the code)
25+
- Push your changes to your forked repository
26+
- Open a pull request to the main repository
27+
- Start with the PR template
28+
- Provide a clear description of your changes and the problem they solve
29+
- Reference any related issues (e.g., "Fixes `#<issue-number>`")
30+
- Be responsive to feedback and make necessary revisions
31+
- Celebrate your contribution to the ecosystem!
32+
33+
## Development Environment
34+
35+
This project uses a source file `dev.sh` to set up the development environment. To get started, follow these steps:
36+
37+
```sh
38+
# Clone the repository
39+
git clone https://github.com/<your-username>/<repository-name>.git
40+
cd <repository-name>
41+
42+
# Source the development environment
43+
source dev.sh
44+
45+
# Setup and run
46+
dev setup
47+
dev run
48+
```
49+
50+
### Available Commands
51+
52+
Use the `dev` command to view and understand the available commands. Here are important commands:
53+
54+
- `dev setup`: Sets up the development environment, including installing dependencies and configuring necessary tools.
55+
- `dev run`: Runs the main application or specific components for testing and development purposes.
56+
- `dev fmt`: Formats the codebase according to the project's coding standards.
57+
- `dev build`: Builds the project for production.
58+
- `dev start`: Starts the project in production mode.
59+
60+

.github/FUNDING.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: [AttAditya]
2+
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Bug Report
2+
description: Report a bug
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: Tell more about the bug you encountered.
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: steps
17+
attributes:
18+
label: Steps to Reproduce
19+
description: If you are able to reproduce the bug, please provide the steps to do so.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: expected
25+
attributes:
26+
label: Expected Behavior
27+
description: What should have happened?
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: logs
33+
attributes:
34+
label: Logs / Screenshots
35+
description: Please include any relevant logs or screenshots.
36+
render: shell
37+

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Additional Support
4+
url: mailto:attachment.aditya@gmail.com
5+
about: In case GitHub features are not sufficient, please reach out to directly, happy to help.
6+
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Feature Request
2+
description: Suggest a feature
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: Tell more about the feature you'd like to see.
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: additional
17+
attributes:
18+
label: Additional Context
19+
description: Is there any additional context or information that would be helpful to know about this feature?
20+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Pull Request Title
2+
3+
## Description
4+
5+
Briefly describe what this PR does and why.
6+
7+
## Changes
8+
9+
- List the main changes made in this PR.
10+
- This should be summary like bullet points
11+
12+
## Previews
13+
14+
- Not applicable / Screenshots / GIFs / Videos
15+
16+
## Type of Change
17+
18+
- `Fix` / `Feature` / `Refactor` / `Documentation` / `Other` (please describe)
19+
- `Breaking Change` / `Non-breaking Change`
20+
21+
## Related Issues
22+
23+
- Related Issues: None / #issue_number
24+
- Related PRs: None / #pr_number
25+

.github/SECURITY.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
If you discover a security vulnerability, please report it privately.
5+
6+
- Email: [attachment.aditya@gmail.com](mailto:attachment.aditya@gmail.com)
7+
- Do NOT open a public issue
8+
9+
## Response
10+
Acknowledgement receipt within a reasonable time and work on a fix.
11+
12+
## Disclosure
13+
Please allow time to fix the issue before public disclosure.
14+

.github/SUPPORT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Support
2+
3+
## Getting Help
4+
- Check the README and docs first
5+
- Search existing issues
6+
7+
## Ask for Help
8+
- Open an issue for bugs or feature requests
9+
- Only open issues that are not already covered by existing issues
10+
11+
## Response Time
12+
Maintainers will respond as time permits.
13+

0 commit comments

Comments
 (0)