This repository has been archived by the owner on Jul 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
3,434 additions
and
816 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,3 +8,4 @@ node_modules | |
!.env.example | ||
vite.config.js.timestamp-* | ||
vite.config.ts.timestamp-* | ||
.vercel |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,30 @@ | ||
# create-svelte | ||
# Noir-UI | ||
|
||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). | ||
Noir-UI is a low-level component library with built in accessibility, built for building high quality design systems. | ||
|
||
## Creating a project | ||
## Installation | ||
|
||
If you're seeing this, you've probably already done this step. Congrats! | ||
Noir-UI is currently in version 0.0.1 and not suitable for production. However to try it, run: | ||
|
||
```bash | ||
# create a new project in the current directory | ||
npm create svelte@latest | ||
npm install @noir-ui/svelte | ||
|
||
# create a new project in my-app | ||
npm create svelte@latest my-app | ||
# or pnpm or yarn | ||
``` | ||
|
||
## Developing | ||
## Documentation | ||
|
||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: | ||
Visit the official [site](https://noir-ui-com.vercel.app). | ||
|
||
```bash | ||
npm run dev | ||
## Author | ||
|
||
# or start the server and open the app in a new browser tab | ||
npm run dev -- --open | ||
``` | ||
[Khairul Haaziq](https://github.com/khairulhaaziq) | ||
|
||
## Building | ||
## Contributing | ||
|
||
To create a production version of your app: | ||
Coming soon. | ||
|
||
```bash | ||
npm run build | ||
``` | ||
## License | ||
|
||
You can preview the production build with `npm run preview`. | ||
MIT License. Copyright Khairul Haaziq 2023. | ||
|
||
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.