|
1 | | -## Once UI monorepo |
| 1 | +<br/> |
2 | 2 |
|
3 | | -This monorepo hosts the official Once UI package and its internal development sandbox. It is designed for testing, development, and contribution—not for production deployment. |
| 3 | +<div align="center"> |
| 4 | + <picture> |
| 5 | + <source media="(prefers-color-scheme: dark)" srcset="https://docs.once-ui.com/trademark/icon-dark.svg" width="64" height="64"> |
| 6 | + <source media="(prefers-color-scheme: light)" srcset="https://docs.once-ui.com/trademark/icon-light.svg" width="64" height="64"> |
| 7 | + <img alt="Once UI Logo" src="https://docs.once-ui.com/trademark/icon-dark.svg" width="64" height="64"> |
| 8 | + </picture><picture> |
| 9 | + <source media="(prefers-color-scheme: dark)" srcset="https://docs.once-ui.com/trademark/type-dark.svg" width="200" height="64"> |
| 10 | + <source media="(prefers-color-scheme: light)" srcset="https://docs.once-ui.com/trademark/type-light.svg" width="200" height="64"> |
| 11 | + <img alt="Once UI Wordmark" src="https://docs.once-ui.com/trademark/type-dark.svg" width="200" height="64"> |
| 12 | + </picture> |
4 | 13 |
|
5 | | -## Developer notice |
| 14 | + <br/> |
6 | 15 |
|
7 | | -It includes: |
| 16 | + The indie design system for Next.js apps |
8 | 17 |
|
9 | | -- `packages/core`: the published [@once-ui-system/core](https://www.npmjs.com/package/@once-ui-system/core) package |
10 | | -- `apps/docs`: the official documentation of Once UI and Magic templates built with [Magic Docs](https://once-ui.com/products/magic-docs) |
11 | | -- `apps/dev`: a simple sandbox app wired via symlink for testing components |
| 18 | + [](https://www.npmjs.com/package/@once-ui-system/core) |
| 19 | + [](./LICENSE.md) |
| 20 | + [](https://www.npmjs.com/package/@once-ui-system/core) |
| 21 | + [](https://discord.com/invite/5EyAQ4eNdS) |
| 22 | +</div> |
12 | 23 |
|
13 | | -This setup is intended for contributors and maintainers. |
14 | | -If you're building a real project, we recommend using: |
15 | 24 |
|
16 | | -1. [Once UI Starter](https://github.com/once-ui-system/nextjs-starter) |
17 | | -2. or install via your package manager: |
18 | 25 |
|
19 | | -```bash |
20 | | -npm install @once-ui-system/core |
21 | | -# or |
22 | | -yarn add @once-ui-system/core |
23 | | -# or |
24 | | -pnpm add @once-ui-system/core |
25 | | -``` |
26 | | - |
27 | | -### For contributors |
28 | | - |
29 | | -Fork this repo, install dependencies, and run apps: |
30 | | - |
31 | | -```bash |
32 | | -pnpm install |
33 | | -pnpm dev |
34 | | -``` |
35 | | - |
36 | | -The components will update automatically when you make changes to the Core library. If you modify the CSS modules, you'll have to run `pnpm build` in the `packages/core` directory. |
| 26 | +<br/> |
37 | 27 |
|
38 | 28 | ## Documentation |
39 | 29 |
|
40 | | -Start here: [docs.once-ui.com](https://docs.once-ui.com/once-ui/quick-start). |
41 | | - |
42 | | -## Creators |
| 30 | +Learn how to set up and build with Once UI at [docs.once-ui.com](https://docs.once-ui.com/once-ui/quick-start). |
43 | 31 |
|
44 | | -**Lorant One**: [Portfolio](https://lorant.one) / [Threads](https://www.threads.net/@lorant.one) / [LinkedIn](https://www.linkedin.com/in/lorant-one/) |
| 32 | +## Installation |
45 | 33 |
|
46 | | -**Collaborators**: [Once UI Frontiers](https://once-ui.com/about) |
| 34 | +```bash |
| 35 | +npm install @once-ui-system/core |
| 36 | +``` |
47 | 37 |
|
48 | | -## Join the movement |
| 38 | +## Authors |
49 | 39 |
|
50 | | - |
| 40 | +Built and maintained by [**Lorant One**](https://lorant.one). |
51 | 41 |
|
52 | | -Join the [Design Engineers Club](https://discord.com/invite/5EyAQ4eNdS) on Discord. Build with intention. Share with integrity. |
| 42 | +## Community |
53 | 43 |
|
54 | | -## Feedback & Bugs |
| 44 | +Join the [Design Engineers Club](https://discord.com/invite/5EyAQ4eNdS) for help, support and discussion. |
55 | 45 |
|
56 | | -Found a bug? [Report it](https://github.com/once-ui-system/core/issues/new?labels=bug&template=bug_report.md) |
57 | | -Got an idea? [Submit a request](https://github.com/once-ui-system/core/issues/new?labels=feature%20request&template=feature_request.md) |
| 46 | +Found a bug? Report it [here](https://github.com/once-ui-system/core/issues/new?labels=bug&template=bug_report.md). Got a feature request? Submit it [here](https://github.com/once-ui-system/core/issues/new?labels=feature%20request&template=feature_request.md). |
58 | 47 |
|
59 | | -## Support us |
| 48 | +## Contributing |
60 | 49 |
|
61 | | -Once UI is an indie project. [Sponsor us](https://github.com/sponsors/once-ui-system) and get featured on our site! |
| 50 | +Please read our [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to Once UI. |
62 | 51 |
|
63 | | -## License |
| 52 | +## Sponsors |
64 | 53 |
|
65 | | -Distributed under the MIT License. See `LICENSE.txt`. |
| 54 | +Once UI is an indie project. [Sponsor us](https://github.com/sponsors/once-ui-system) and get featured on our site! |
0 commit comments