Skip to content

Commit

Permalink
feat(app): add playground
Browse files Browse the repository at this point in the history
  • Loading branch information
Selemondev authored and Selemondev committed Jul 25, 2023
1 parent feacf12 commit 69d3671
Show file tree
Hide file tree
Showing 70 changed files with 7,958 additions and 12,241 deletions.
7 changes: 7 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dist
public
es
node_modules
playground/*
example/*
docs/*
19 changes: 19 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"extends": [
"@antfu"
],
"rules": {
"react/display-name": "off",
"react-hooks/rules-of-hooks": "off",
"no-sequences": "off",
"no-alert": "off",
"no-console": [
"error",
{
"allow": [
"error"
]
}
]
}
}
21 changes: 20 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
node_modules
.cache
.DS_Store
.idea
.nuxt
.output
.temp
*.local
*.log
*.vsix
.temp
.eslintcache

coverage
dist
node_modules

# style copy with components build
packages/onu-ui/*.css
docs/.vitepress/cache/
docs/public/play
5 changes: 5 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
registry=https://registry.npmjs.org
ignore-workspace-root-check=true
shamefully-hoist=true
strict-peer-dependencies=false
auto-install-peers=false
1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @selemondev
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@

# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at selemondev19@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
109 changes: 109 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Contributing

Thank you for your valuable contribution and dedication to improving this project! We greatly appreciate your involvement. To ensure a smooth and cohesive collaboration, we have provided some guidelines to help you get started. Kindly take a moment to review them before submitting your contributions. Your efforts will undoubtedly make this project even better, and we look forward to working together on its success!.

## Code of Conduct

This project is governed by the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to adhere to it.

## Open Development

All work happens directly on `GitHub`. Both core team members and external contributors send pull requests which go through the same `code review` process.

## Semantic Versioning

This project follows semantic versioning. We release patch versions for bug fixes or other changes that do not change the behavior of the API, minor versions for new features that are backward-compatible, and major versions for any breaking changes.

Every significant change is documented in the changelog file.

## Reporting Issues

Welcome to Windi UI! We value your feedback and contributions to make this project better. If you encounter any bugs or have feature requests, please use [Github issues](https://github.com/windi-ui/windi-ui/issues) issues to submit them.

Before reporting an issue, we ask you to:

1. `Search for Similar Issues` : Ensure you have searched through our existing issues to see if the problem or feature request has already been addressed or is under discussion.

2. `Reproduce the Bug` : If reporting a bug, please provide the minimum code required to reproduce the issue. This will help us understand and resolve the problem more efficiently.

3. `Describe Feature Requests` : For feature requests, please describe the desired functionality and any additional context that might be helpful.

Your participation and attention to these guidelines will help us maintain a more organized and effective development process.

## Sending a pull request

1. Fork [the repository](https://github.com/windi-ui/windi-ui),and create your branch from `main`. For new feature, please submit your changes directly to the `feature` branch. Other changes should go against `main` branch.
2. Use `pnpm install` install the dependencies
3. Use `pnpm run dev` start project, RUN `pnpm run play` start the `playground`, RUN `pnpm run docs` to write docs, usually a dev server and document server can be debugged.
4. Make changes to the codebase. Please add `tests` if applicable.
5. Make sure the test suite passes with `pnpm run test`.
6. Use `pnpm run test:ci` to RUN `CI` tests before you commit your code.
8. Commit your changes, adhering to the [Commit Guidelines](#commit-guidelines).
9. Open a new pull request, [referencing corresponding issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) if available.

## Commit Guidelines

Commit messages are required to follow the [conventional-changelog standard](https://www.conventionalcommits.org/en/v1.0.0/):

```bash
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
```

👉 [Commit example](https://github.com/unocss/unocss/releases/tag/v0.39.0)

### Commit types

The following is a list of commit types:

### Commit Types:

- `feat`: Adding a new UI component or significant functionality to the library. Examples:
- Added a new dropdown menu component.
- Implemented a dark mode feature for all components.

- `fix`: Addressing bugs or issues in existing UI components. Examples:
- Fixed misalignment in the button component.
- Resolved an issue with the modal not closing correctly.

- `docs`: Commits related to documentation changes for Windi UI components. Examples:
- Updated usage examples in the README for the carousel component.
- Added API documentation for the accordion component.

- `style`: Commits related to code formatting, styling, or theming of UI components. Examples:
- Improved button styles for better consistency across browsers.
- Updated color palette for a more cohesive design.

- `refactor`: Code changes that enhance the library's structure without introducing new features or fixing bugs. Examples:
- Reorganized folder structure for better modularity.
- Simplified the logic in a component to improve maintainability.

- `perf`: Commits aimed at improving performance for UI components. Examples:
- Optimized rendering logic in the data table component.
- Reduced the size of assets for faster loading times.

- `test`: Commits related to testing Windi UI components. Examples:
- Added unit tests for the accordion component to ensure functionality.
- Fixed failing test cases for the dropdown menu.

- `chore`: Other commits not affecting source or test files directly. Examples:
- Updated third-party dependencies in package.json.
- Ignored build output in .gitignore.


## Windi UI Repository Structure

This repository is managed by `pnpm` and includes the following packages:

1. `windi-ui`: Main UI component library for Vue
2. `nuxt-windi-ui`: Main nuxt module for Windi UI
3. `docs`: Component documentation site
4. `example`: Example of debugging a UI component
5. `playground`: UI component playground

## License

By contributing your code to the repository, you agree to license your contribution under the [MIT license](./LICENSE).
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) 2023 Windi-UI & Selemondev

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.
Empty file added README.md
Empty file.
19 changes: 0 additions & 19 deletions docs/.vitepress/cache/deps/_metadata.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/.vitepress/cache/deps/package.json

This file was deleted.

0 comments on commit 69d3671

Please sign in to comment.