Skip to content

Commit 0541ebe

Browse files
committed
chore: prepare dashboard for open source
0 parents  commit 0541ebe

309 files changed

Lines changed: 31172 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.

.dockerignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
node_modules
2+
dist
3+
.git
4+
.github
5+
.tanstack
6+
docker-compose*.yml
7+
*.log

.env.example

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Simprint Dashboard example environment
2+
3+
# Dashboard identifier used as the first URL segment.
4+
# Example access path: https://your-domain.com/{VITE_DASHBOARD_IDENTIFIER}/
5+
VITE_DASHBOARD_IDENTIFIER=cp-8f2k9m4x
6+
7+
# Console server origin only. The frontend appends /api/v1 automatically.
8+
# Development example: http://localhost:40043
9+
VITE_API_BASE_URL=http://localhost:40043
10+
11+
# Optional extension sync service base URL.
12+
# Development example: http://localhost:8080
13+
# Bundled Nginx proxy example: /extension-sync
14+
VITE_EXTENSION_SYNC_BASE_URL=http://localhost:8080
15+
16+
# Runtime port used by the Docker deploy bundle.
17+
DASHBOARD_PORT=8080

.github/CODE_OF_CONDUCT.md

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

.github/CONTRIBUTING.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Contributing to Shadcn-Admin
2+
3+
Thank you for considering contributing to **shadcn-admin**! Every contribution is valuable, whether it's reporting bugs, suggesting improvements, adding features, or refining README.
4+
5+
## Table of Contents
6+
7+
1. [Getting Started](#getting-started)
8+
2. [How to Contribute](#how-to-contribute)
9+
3. [Code Standards](#code-standards)
10+
4. [Pull Request Guidelines](#pull-request-guidelines)
11+
5. [Reporting Issues](#reporting-issues)
12+
6. [Community Guidelines](#community-guidelines)
13+
14+
---
15+
16+
## Getting Started
17+
18+
1. **Fork** the repository.
19+
2. **Clone** your fork:
20+
21+
```bash
22+
git clone https://github.com/your-username/shadcn-admin.git
23+
```
24+
25+
3. **Install dependencies:**
26+
27+
```bash
28+
pnpm install
29+
```
30+
31+
4. **Run the project locally:**
32+
33+
```bash
34+
pnpm dev
35+
```
36+
37+
5. Create a new branch for your contribution:
38+
39+
```bash
40+
git checkout -b feature/your-feature
41+
```
42+
43+
---
44+
45+
## How to Contribute
46+
47+
- **Feature Requests:** Open an issue or start a discussion to discuss the feature before implementation.
48+
- **Bug Fixes:** Provide clear reproduction steps in your issue.
49+
- **Documentation:** Improvements to the documentation (README) are always appreciated.
50+
51+
> **Note:** Pull Requests adding new features without a prior issue or discussion will **not be accepted**.
52+
53+
---
54+
55+
## Code Standards
56+
57+
- Follow the existing **ESLint** and **Prettier** configurations.
58+
- Ensure your code is **type-safe** with **TypeScript**.
59+
- Maintain consistency with the existing code structure.
60+
61+
> **Tips!** Before submitting your changes, run the following commands:
62+
63+
```bash
64+
pnpm lint && pnpm format && pnpm knip && pnpm build
65+
```
66+
67+
---
68+
69+
## Pull Request Guidelines
70+
71+
- **Follow the [PR Template](./PULL_REQUEST_TEMPLATE.md):**
72+
- Description
73+
- Types of changes
74+
- Checklist
75+
- Further comments
76+
- Related Issue
77+
- Ensure your changes pass **CI checks**.
78+
- Keep PRs **focused** and **concise**.
79+
- Reference related issues in your PR description.
80+
81+
---
82+
83+
## Reporting Issues
84+
85+
- Clearly describe the issue.
86+
- Provide reproduction steps if applicable.
87+
- Include screenshots or code examples if relevant.
88+
89+
---
90+
91+
## Community Guidelines
92+
93+
- Be respectful and constructive.
94+
- Follow the [Code of Conduct](./CODE_OF_CONDUCT.md).
95+
- Stay on topic in discussions.
96+
97+
---
98+
99+
Thank you for helping make **shadcn-admin** better! 🚀
100+
101+
If you have any questions, feel free to reach out via [Discussions](https://github.com/satnaing/shadcn-admin/discussions).

.github/FUNDING.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
github: [satnaing]
2+
buy_me_a_coffee: satnaing
3+
4+
# patreon: # Replace with a single Patreon username
5+
# open_collective: # Replace with a single Open Collective username
6+
# ko_fi: # Replace with a single Ko-fi username
7+
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
# liberapay: # Replace with a single Liberapay username
10+
# issuehunt: # Replace with a single IssueHunt username
11+
# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12+
# polar: # Replace with a single Polar username
13+
# thanks_dev: # Replace with a single thanks.dev username
14+
# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.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: Shadcn-Admin Discussions
4+
url: https://github.com/satnaing/shadcn-admin/discussions
5+
about: Please ask and answer questions here.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "✨ Feature Request"
3+
about: Suggest an idea for improving Shadcn-Admin
4+
title: "[Feature Request]: "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "\U0001F41E Bug report"
3+
about: Report a bug or unexpected behavior in Shadcn-Admin
4+
title: "[BUG]: "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Additional context**
27+
Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Description
2+
3+
<!-- A clear and concise description of what the pull request does. Include any relevant motivation and background. -->
4+
5+
## Types of changes
6+
7+
<!-- What types of changes does your code introduce to AstroPaper? Put an `x` in the boxes that apply -->
8+
9+
- [ ] Bug Fix (non-breaking change which fixes an issue)
10+
- [ ] New Feature (non-breaking change which adds functionality)
11+
- [ ] Others (any other types not listed above)
12+
13+
## Checklist
14+
15+
<!-- Please follow this checklist and put an x in each of the boxes, like this: [x]. You can also fill these out after creating the PR. This is simply a reminder of what we are going to look for before merging your code. -->
16+
17+
- [ ] I have read the [Contributing Guide](https://github.com/satnaing/shadcn-admin/blob/main/.github/CONTRIBUTING.md)
18+
19+
## Further comments
20+
21+
<!-- If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... -->
22+
23+
## Related Issue
24+
25+
<!-- If this PR is related to an existing issue, link to it here. -->
26+
27+
Closes: #<!-- Issue number, if applicable -->

.github/workflows/ci.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Continuous Integration
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
pull_request:
9+
branches:
10+
- main
11+
12+
jobs:
13+
install-lint-build:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: 20
24+
25+
- name: Install pnpm
26+
run: npm install -g pnpm
27+
28+
- name: Install dependencies
29+
run: pnpm install --frozen-lockfile
30+
31+
- name: Lint the code
32+
run: pnpm lint
33+
34+
# - name: Analyze unused files and dependencies
35+
# run: pnpm knip
36+
37+
- name: Run Prettier check
38+
run: pnpm format:check
39+
40+
- name: Build the project
41+
run: pnpm build

0 commit comments

Comments
 (0)