Skip to content

Commit 5ac1a53

Browse files
codeaashucodeaashu
committed
DevDisplay - Open Source
1 parent 86ffe2d commit 5ac1a53

Some content is hidden

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

47 files changed

+20065
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 🐞 Bug Report
2+
description: File a bug report
3+
title: '[Bug]: '
4+
labels: ['bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: Also tell us, what did you expect to happen?
15+
placeholder: Add descriptions
16+
value: 'I found a BUG 🐞'
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: screenshots
21+
attributes:
22+
label: Add screenshots
23+
description: Add screenshots to see the problems
24+
placeholder: Add screenshots
25+
value: 'Add screenshots'
26+
- type: dropdown
27+
id: browsers
28+
attributes:
29+
label: What browsers are you seeing the problem on?
30+
multiple: true
31+
options:
32+
- Firefox
33+
- Chrome
34+
- Safari
35+
- Microsoft Edge
36+
- Brave
37+
- Other
38+
- type: checkboxes
39+
id: terms
40+
attributes:
41+
label: Code of Conduct
42+
description: By submitting this issue, you agree to follow our Code of Conduct
43+
options:
44+
- label: I agree to follow this project's Code of Conduct

‎.github/ISSUE_TEMPLATE/docs.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 🔖 Documentation update
2+
description: Improve Documentation
3+
title: '[Docs]: '
4+
labels: ['documentation']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this documentation update template!
10+
- type: textarea
11+
id: improve-docs
12+
attributes:
13+
label: what's wrong in the documentation?
14+
description: which things need to add?
15+
placeholder: Add descriptions
16+
value: 'We need to add '
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: screenshots
21+
attributes:
22+
label: Add screenshots
23+
description: Add screenshots to see the demo
24+
placeholder: Add screenshots
25+
value: 'Add screenshots'
26+
- type: checkboxes
27+
id: terms
28+
attributes:
29+
label: Code of Conduct
30+
description: By submitting this issue, you agree to follow our Code of Conduct
31+
options:
32+
- label: I agree to follow this project's Code of Conduct

‎.github/ISSUE_TEMPLATE/feature.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: ✨ Feature Request
2+
description: Suggest a feature request
3+
title: '[Feat]: '
4+
labels: ['enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this feature request template!
10+
- type: textarea
11+
id: what-feature
12+
attributes:
13+
label: What feature?
14+
placeholder: Add descriptions
15+
value: 'I have an idea '
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: screenshots
20+
attributes:
21+
label: Add screenshots
22+
description: Add screenshots to see the demo
23+
placeholder: Add screenshots
24+
value: 'Add screenshots'
25+
- type: checkboxes
26+
id: terms
27+
attributes:
28+
label: Code of Conduct
29+
description: By submitting this issue, you agree to follow our Code of Conduct
30+
options:
31+
- label: I agree to follow this project's Code of Conduct

‎.github/ISSUE_TEMPLATE/style.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 👯‍♂️ Style Changing Request
2+
description: Suggest a style designs
3+
title: '[style]: '
4+
labels: ['enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this template!
10+
- type: textarea
11+
id: style-idea
12+
attributes:
13+
label: What's the style idea?
14+
placeholder: Add descriptions
15+
value: 'We need to improve '
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: screenshots
20+
attributes:
21+
label: Add screenshots
22+
description: Add screenshots to see the demo
23+
placeholder: Add screenshots
24+
value: 'Add screenshots'
25+
- type: checkboxes
26+
id: terms
27+
attributes:
28+
label: Code of Conduct
29+
description: By submitting this issue, you agree to follow our Code of Conduct
30+
options:
31+
- label: I agree to follow this project's Code of Conduct

‎.github/dependabot.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: 'npm'
4+
directory: '/'
5+
schedule:
6+
interval: 'daily'

‎.github/pull_request_template.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Description
2+
3+
<!--- Include a brief description of the changes you've made --->
4+
5+
## Related Issues
6+
7+
<!--- Include any related issues or pull requests that this PR addresses or is related to. Use GitHub's shorthand syntax to link to them, like #1234. --->
8+
9+
## Changes Proposed
10+
11+
<!--- Describe the changes you've made in detail. Be specific and include any relevant code snippets. --->
12+
13+
## Checklist
14+
15+
- [ ] I have read and followed the [Contribution Guidelines](https://github.com/shyamtawli/devFind/blob/master/CONTRIBUTING.md).
16+
- [ ] All new and existing tests passed.
17+
- [ ] I have updated the documentation to reflect the changes I've made.
18+
- [ ] My code follows the code style of this project.
19+
- [ ] The title of my pull request is a short description of the requested changes.
20+
21+
## Screenshots
22+
23+
## Note to reviewers

‎.github/workflows/JSONchecker.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: JSON check
2+
3+
on:
4+
push:
5+
paths:
6+
- '**.json'
7+
pull_request:
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: json-syntax-check
15+
uses: limitusus/json-syntax-check@v2
16+
with:
17+
pattern: "\\.json$"

‎.github/workflows/greetings.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: 'Greetings'
2+
3+
on:
4+
fork:
5+
push:
6+
branches: [main]
7+
issues:
8+
types: [opened]
9+
pull_request_target:
10+
types: [opened]
11+
12+
jobs:
13+
welcome:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v1
17+
- uses: EddieHubCommunity/gh-action-community/src/welcome@main
18+
with:
19+
github-token: ${{ secrets.GITHUB_TOKEN }}
20+
issue-message: "Welcome, @${{ github.actor }}! Your issue is like a spark that ignites innovation. We're thrilled to dive into it and work together to find a solution."
21+
pr-message: 'Great job, @${{ github.actor }}! 🎉 Thank you for opening a pull request. Your contribution is valuable and we appreciate your efforts to improve our project.'
22+
footer: 'Soon the maintainers/owner will review it and provide you with feedback/suggestions.'

‎.gitignore

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/build
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npm run format && git add .

‎.prettierrc.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"plugins": ["prettier-plugin-tailwindcss"],
3+
"printWidth": 120,
4+
"semi": true,
5+
"singleQuote": true,
6+
"tabWidth": 2,
7+
"trailingComma": "all",
8+
"bracketSpacing": true
9+
}

‎CODE_OF_CONDUCT.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Code of Conduct for DevDisplay
2+
3+
DevDisplay is an open source project that welcomes all individuals regardless of their background, experience level, or identity. We strive to foster an inclusive and respectful community where everyone feels safe and supported.
4+
5+
As contributors and maintainers of this project, we pledge to adhere to the following code of conduct:
6+
7+
1. **Respect and kindness:** We will treat all individuals with respect and kindness, regardless of their background or identity. We will not tolerate any form of harassment, discrimination, or disrespectful behavior.
8+
9+
2. **Inclusivity:** We welcome and encourage the participation of individuals from all backgrounds and experiences. We strive to create an environment that is inclusive and welcoming to everyone.
10+
11+
3. **Open communication:** We will communicate openly and honestly with each other. We will listen to each other's perspectives and work together to find solutions to problems.
12+
13+
4. **Professionalism:** We will conduct ourselves professionally and maintain a high standard of behavior at all times. We will avoid personal attacks, aggressive behavior, or any other conduct that could be perceived as unprofessional.
14+
15+
5. **Safety:** We will prioritize the safety and well-being of all members of our community. We will take appropriate action to address any safety concerns or violations of this code of conduct.
16+
17+
6. **Accountability:** We will hold ourselves and others accountable for our actions and behavior. We will take responsibility for our mistakes and work to make things right.
18+
19+
7. **Continuous improvement:** We recognize that we are all constantly learning and growing. We will strive to continuously improve our knowledge, skills, and behavior to create a better community for everyone.
20+
21+
We encourage all members of our community to uphold this code of conduct and to help us create a safe, inclusive, and welcoming environment for all. If you witness or experience any behavior that violates this code of conduct, please report it to the project maintainers immediately.
22+
23+
Thank you for your participation in the DevDisplay community.

‎CONTRIBUTING.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
Thank you for your interest in contributing to DevDisplay! Here's a guide to get you started on your exciting coding adventure! 🚀
2+
3+
## **Set up your environment**
4+
5+
To embark on your DevDisplay journey, you'll need a few tools. Make sure you have Node.js and Git installed on your computer. You can download Node.js from the [official website](https://nodejs.org/en/download). For Git, visit [this link](https://git-scm.com/downloads).
6+
7+
Once you have these in place, let's get the DevDisplay repository onto your local machine. Fire up your terminal and run this command:
8+
9+
```bash
10+
git clone https://github.com/codeaashu/DevDisplay.git
11+
```
12+
13+
## **Install dependencies**
14+
15+
Time to gather our supplies! Navigate to the project folder in your terminal and install the dependencies with these magical incantations:
16+
17+
```bash
18+
cd DevDisplay
19+
npm install
20+
```
21+
22+
## **Launch the Application**
23+
24+
Ready to unveil your creation? Use this command to start the application:
25+
26+
```bash
27+
npm start
28+
```
29+
30+
## **Create a New Branch**
31+
32+
Now, before you unleash your creativity, let's create a new branch. This will be your canvas for crafting your masterpiece. Execute this command:
33+
34+
```bash
35+
git checkout -b your-branch-name
36+
```
37+
38+
## **Make Your Changes**
39+
40+
The world of DevDisplay is your oyster! Make your changes, tweak existing code, add dazzling new features, or zap those pesky bugs.
41+
42+
## **Test Your Changes**
43+
44+
Before you reveal your wizardry, ensure everything works like a charm. Run the tests with this enchantment:
45+
46+
```bash
47+
npm test
48+
```
49+
50+
The tests will act as your trusty spellbook, guiding you to victory!
51+
52+
## **Commit Your Changes**
53+
54+
You're ready to immortalize your work. Commit your changes to your local branch using this incantation:
55+
56+
```bash
57+
git add .
58+
git commit -m "Your magical commit message"
59+
```
60+
61+
## **Push Your Changes**
62+
63+
With your spells ready, it's time to share your magic with the world. Push your changes to your remote branch:
64+
65+
```bash
66+
git push origin your-branch-name
67+
```
68+
69+
## **Create a Pull Request**
70+
71+
Your masterpiece is ready for the world to see! Navigate to the DevDisplay repository on GitHub, and with a flourish, click the "New pull request" button. Follow the magical instructions to create your pull request.
72+
73+
## **Participate in Code Reviews**
74+
75+
Your spellbinding creation will be reviewed by fellow wizards and witches to ensure it meets the project's high standards. Be ready to cast additional spells or address any mystical feedback provided.
76+
77+
## **Merge Your Changes**
78+
79+
When your pull request is blessed by the council of wizards and passes all tests, it can be merged into the main codebase. Congratulations, you've successfully left your mark on DevDisplay! 🪄🔮✨

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Ashutosh Singh
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.

0 commit comments

Comments
 (0)