Skip to content

Commit

Permalink
DevDisplay - Open Source
Browse files Browse the repository at this point in the history
  • Loading branch information
codeaashu committed Sep 13, 2024
1 parent 86ffe2d commit 5ac1a53
Show file tree
Hide file tree
Showing 47 changed files with 20,065 additions and 2 deletions.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: 🐞 Bug Report
description: File a bug report
title: '[Bug]: '
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Add descriptions
value: 'I found a BUG 🐞'
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add screenshots
description: Add screenshots to see the problems
placeholder: Add screenshots
value: 'Add screenshots'
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Brave
- Other
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: 🔖 Documentation update
description: Improve Documentation
title: '[Docs]: '
labels: ['documentation']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this documentation update template!
- type: textarea
id: improve-docs
attributes:
label: what's wrong in the documentation?
description: which things need to add?
placeholder: Add descriptions
value: 'We need to add '
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add screenshots
description: Add screenshots to see the demo
placeholder: Add screenshots
value: 'Add screenshots'
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: ✨ Feature Request
description: Suggest a feature request
title: '[Feat]: '
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request template!
- type: textarea
id: what-feature
attributes:
label: What feature?
placeholder: Add descriptions
value: 'I have an idea '
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add screenshots
description: Add screenshots to see the demo
placeholder: Add screenshots
value: 'Add screenshots'
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/style.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: 👯‍♂️ Style Changing Request
description: Suggest a style designs
title: '[style]: '
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this template!
- type: textarea
id: style-idea
attributes:
label: What's the style idea?
placeholder: Add descriptions
value: 'We need to improve '
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add screenshots
description: Add screenshots to see the demo
placeholder: Add screenshots
value: 'Add screenshots'
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: 'daily'
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Description

<!--- Include a brief description of the changes you've made --->

## Related Issues

<!--- 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. --->

## Changes Proposed

<!--- Describe the changes you've made in detail. Be specific and include any relevant code snippets. --->

## Checklist

- [ ] I have read and followed the [Contribution Guidelines](https://github.com/shyamtawli/devFind/blob/master/CONTRIBUTING.md).
- [ ] All new and existing tests passed.
- [ ] I have updated the documentation to reflect the changes I've made.
- [ ] My code follows the code style of this project.
- [ ] The title of my pull request is a short description of the requested changes.

## Screenshots

## Note to reviewers
17 changes: 17 additions & 0 deletions .github/workflows/JSONchecker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: JSON check

on:
push:
paths:
- '**.json'
pull_request:

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: json-syntax-check
uses: limitusus/json-syntax-check@v2
with:
pattern: "\\.json$"
22 changes: 22 additions & 0 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: 'Greetings'

on:
fork:
push:
branches: [main]
issues:
types: [opened]
pull_request_target:
types: [opened]

jobs:
welcome:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: EddieHubCommunity/gh-action-community/src/welcome@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
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."
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.'
footer: 'Soon the maintainers/owner will review it and provide you with feedback/suggestions.'
23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run format && git add .
9 changes: 9 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"plugins": ["prettier-plugin-tailwindcss"],
"printWidth": 120,
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "all",
"bracketSpacing": true
}
23 changes: 23 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Code of Conduct for DevDisplay

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.

As contributors and maintainers of this project, we pledge to adhere to the following code of conduct:

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.

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.

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.

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.

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.

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.

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.

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.

Thank you for your participation in the DevDisplay community.
79 changes: 79 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
Thank you for your interest in contributing to DevDisplay! Here's a guide to get you started on your exciting coding adventure! 🚀

## **Set up your environment**

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).

Once you have these in place, let's get the DevDisplay repository onto your local machine. Fire up your terminal and run this command:

```bash
git clone https://github.com/codeaashu/DevDisplay.git
```

## **Install dependencies**

Time to gather our supplies! Navigate to the project folder in your terminal and install the dependencies with these magical incantations:

```bash
cd DevDisplay
npm install
```

## **Launch the Application**

Ready to unveil your creation? Use this command to start the application:

```bash
npm start
```

## **Create a New Branch**

Now, before you unleash your creativity, let's create a new branch. This will be your canvas for crafting your masterpiece. Execute this command:

```bash
git checkout -b your-branch-name
```

## **Make Your Changes**

The world of DevDisplay is your oyster! Make your changes, tweak existing code, add dazzling new features, or zap those pesky bugs.

## **Test Your Changes**

Before you reveal your wizardry, ensure everything works like a charm. Run the tests with this enchantment:

```bash
npm test
```

The tests will act as your trusty spellbook, guiding you to victory!

## **Commit Your Changes**

You're ready to immortalize your work. Commit your changes to your local branch using this incantation:

```bash
git add .
git commit -m "Your magical commit message"
```

## **Push Your Changes**

With your spells ready, it's time to share your magic with the world. Push your changes to your remote branch:

```bash
git push origin your-branch-name
```

## **Create a Pull Request**

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.

## **Participate in Code Reviews**

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.

## **Merge Your Changes**

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! 🪄🔮✨
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Ashutosh Singh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 5ac1a53

Please sign in to comment.