176 lines
14 KiB
Markdown
176 lines
14 KiB
Markdown
# Notus Svelte <a href="https://twitter.com/intent/tweet?url=https%3A%2F%2Fdemos.creative-tim.com%2Fnotus-svelte%2F&text=Start%20your%20development%20with%20a%20Free%20Tailwind%20CSS%20and%20Svelte%20UI%20Kit%20and%20Admin.%20Let%20Notus%20Svelte%20amaze%20you%20with%20its%20cool%20features%20and%20build%20tools%20and%20get%20your%20project%20to%20a%20whole%20new%20level." target="_blank"></a>
|
||
|
||
  <a href="https://github.com/creativetimofficial/notus-svelte/issues?q=is%3Aopen+is%3Aissue" target="_blank"></a> <a href="https://github.com/creativetimofficial/notus-svelte/issues?q=is%3Aissue+is%3Aclosed" target="_blank"></a> <a href="https://gitter.im/creative-tim-general/Lobby" target="_blank"></a> <a href="https://discord.gg/E4aHAQy" target="_blank"></a>
|
||
|
||
|
||
|
||
### A beautiful UI Kit and Admin for Tailwind CSS and Svelte.
|
||
|
||
Start your development with a Free Tailwind CSS and Svelte UI Kit and Admin. Let Notus Svelte amaze you with its cool features and build tools and get your project to a whole new level.
|
||
|
||
Notus Svelte is Free and Open Source. It features multiple HTML and Svelte elements and it comes with dynamic components for Svelte.
|
||
|
||
It is based on [Tailwind Starter Kit](https://www.creative-tim.com/learning-lab/tailwind-starter-kit/presentation?ref=ns-github-readme) by Creative Tim, and it is build with both presentation pages, and pages for an admin dashboard.
|
||
|
||
Speed up your web development with a beautiful product made by <a href="https://creative-tim.com/" target="_blank">Creative Tim </a>.
|
||
If you like bright and fresh colors, you will love this Free Tailwind CSS Template! It features a huge number of components that can help you create amazing websites.
|
||
|
||
### Get Started
|
||
|
||
- Install NodeJS **LTS** version from <a href="https://nodejs.org/en/?ref=creativetim">NodeJs Official Page</a>
|
||
- Download the product on this page
|
||
- Unzip the downloaded file to a folder in your computer
|
||
- Open Terminal
|
||
- Go to your file project (where you’ve unzipped the product)
|
||
- (If you are on a linux based terminal) Simply run `npm run install:clean`
|
||
- (If not) Run in terminal `npm install`
|
||
- (If not) Run in terminal `npm run build:tailwind` (each time you add a new class, a class that does not exist in `src/assets/styles/tailwind.css`, you will need to run this command)
|
||
- (If not) Run in terminal `npm run build:fontawesome`
|
||
- (If not) Run in terminal `npm run dev`
|
||
- Navigate to https://localhost:5000
|
||
- Check more about [Tailwind CSS](https://tailwindcss.com/?ref=creativetim)
|
||
|
||
### Pages
|
||
|
||
If you want to get inspiration or just show something directly to your clients,
|
||
you can jump start your development with our pre-built example pages. You will be able
|
||
to quickly set up the basic structure for your web project.
|
||
|
||
Here are all the page from the project:
|
||
- [Presentation](https://demos.creative-tim.com/notus-svelte/?ref=ns-github-readme)
|
||
- Admin Samples
|
||
- [Dashboard](https://demos.creative-tim.com/notus-svelte/admin/dashboard?ref=ns-github-readme)
|
||
- [Settings](https://demos.creative-tim.com/notus-svelte/admin/settings?ref=ns-github-readme)
|
||
- [Tables](https://demos.creative-tim.com/notus-svelte/admin/tables?ref=ns-github-readme)
|
||
- [Maps](https://demos.creative-tim.com/notus-svelte/admin/maps?ref=ns-github-readme)
|
||
- Authentication Samples
|
||
- [Login](https://demos.creative-tim.com/notus-svelte/auth/login?ref=ns-github-readme)
|
||
- [Register](https://demos.creative-tim.com/notus-svelte/auth/register?ref=ns-github-readme)
|
||
- Presentation Samples
|
||
- [Landing](https://demos.creative-tim.com/notus-svelte/landing?ref=ns-github-readme)
|
||
- [Profile](https://demos.creative-tim.com/notus-svelte/profile?ref=ns-github-readme)
|
||
|
||
|
||
### Fully Coded Components
|
||
|
||
Notus Svelte is built with over frontend 120 components, giving you the freedom of choosing and combining. All components can take variations in colors, that you can easily modify using Tailwind CSS classes (NOTE: each time you add a new class, a class that does not exist in `assets/styles/tailwind.css`, you will need to compile again tailwind).
|
||
|
||
You will save a lot of time going from prototyping to full-functional code, because all elements are implemented.
|
||
This Free Tailwind CSS Template is coming with prebuilt examples, so the development process is seamless, switching from our pages to the real website is very easy to be done.
|
||
|
||
Every element has multiple states for colors, styles, hover, focus, that you can easily access and use.
|
||
|
||
|
||
### CSS Components
|
||
|
||
Notus Svelte comes with 120 Fully Coded CSS elements, such as [Alerts](https://www.creative-tim.com/learning-lab/tailwind/svelte/alerts/notus?ref=ns-github-readme), [Buttons](https://www.creative-tim.com/learning-lab/tailwind/svelte/buttons/notus?ref=ns-github-readme), [Inputs](https://www.creative-tim.com/learning-lab/tailwind/svelte/inputs/notus?ref=ns-github-readme) and many more.
|
||
|
||
Please [check all of them here](https://www.creative-tim.com/learning-lab/tailwind/svelte/alerts/notus?ref=ns-github-readme).
|
||
|
||
### Svelte Components
|
||
|
||
We also feature the following 18 dynamic components:
|
||
- [Alerts](https://www.creative-tim.com/learning-lab/tailwind/svelte/alerts/notus?tws=twr-github-readme)
|
||
- [Popper for Menus](https://www.creative-tim.com/learning-lab/tailwind/svelte/dropdowns/notus?tws=twr-github-readme)
|
||
- [Menus](https://www.creative-tim.com/learning-lab/tailwind/svelte/menus/notus?ref=ns-github-readme)
|
||
- [Modals](https://www.creative-tim.com/learning-lab/tailwind/svelte/modals/notus?ref=ns-github-readme)
|
||
- [Navbars](https://www.creative-tim.com/learning-lab/tailwind/svelte/navbar/notus?ref=ns-github-readme)
|
||
- [Popper for popover content](https://www.creative-tim.com/learning-lab/tailwind/svelte/popovers/notus?ref=ns-github-readme)
|
||
- [Tabs](https://www.creative-tim.com/learning-lab/tailwind/svelte/tabs/notus?ref=ns-github-readme)
|
||
- [Popper for tooltips content](https://www.creative-tim.com/learning-lab/tailwind/svelte/tooltips/notus?ref=ns-github-readme)
|
||
|
||
|
||
## Table of Contents
|
||
|
||
* [Versions](#versions)
|
||
* [Documentation](#documentation)
|
||
* [Quick Start](#quick-start)
|
||
* [Files and folders](#files-and-folders)
|
||
* [Browser Support](#browser-support)
|
||
* [Reporting Issues](#reporting-issues)
|
||
* [Licensing](#licensing)
|
||
* [Useful Links](#useful-links)
|
||
* [Resources](#resources)
|
||
|
||
## Versions
|
||
|
||
[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/angular.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/notus-angular?ref=ns-github-readme)[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/js.png?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/notus-js?ref=ns-github-readme)[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/nextjs.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/notus-nextjs?ref=ns-github-readme)[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/react.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/notus-react?ref=ns-github-readme)[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/svelte.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/notus-svelte?ref=ns-github-readme)[<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/vue.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/vue-notus?ref=ns-github-readme)
|
||
|
||
|
||
| Angular | JavaScript / HTML | NextJS | React | Svelte | VueJS |
|
||
| :---: | :---: | :---: | :---: | :---: | :---: |
|
||
| [](https://www.creative-tim.com/product/notus-angular?ref=ns-github-readme) | [](https://www.creative-tim.com/product/notus-js?ref=ns-github-readme) | [](https://www.creative-tim.com/product/notus-nextjs?ref=ns-github-readme) | [](https://www.creative-tim.com/product/notus-react?ref=ns-github-readme) | [](https://www.creative-tim.com/product/notus-svelte?ref=ns-github-readme) | [](https://www.creative-tim.com/product/vue-notus?ref=ns-github-readme)
|
||
|
||
## Documentation
|
||
The documentation for the Notus Svelte is hosted at our <a href="https://www.creative-tim.com/learning-lab/tailwind/svelte/overview/notus?ref=ns-readme" target="_blank">website</a>.
|
||
|
||
## Quick start
|
||
|
||
- <a href="https://www.creative-tim.com/product/notus-svelte?ref=ns-github-readme" target="_blank">Download from Creative Tim</a>.
|
||
- <a href="https://github.com/creativetimofficial/notus-svelte" target="_blank">Check it on Github</a>.
|
||
|
||
## Files and Folder
|
||
|
||
This is the project structure that you will get upon the download:
|
||
```
|
||
notus-svelte
|
||
.
|
||
|
||
```
|
||
|
||
## Browser Support
|
||
|
||
At present, we officially aim to support the last two versions of the following browsers:
|
||
|
||
| Chrome | Firefox | Edge | Safari | Opera |
|
||
|:---:|:---:|:---:|:---:|:---:|
|
||
| <img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/chrome-logo.png?raw=true" width="64" height="64"> | <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/firefox-logo.png" width="64" height="64"> | <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/edge-logo.png" width="64" height="64"> | <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/safari-logo.png" width="64" height="64"> | <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/opera-logo.png" width="64" height="64"> |
|
||
|
||
## Reporting Issues
|
||
|
||
We use GitHub Issues as the official bug tracker for the Notus Svelte. Here are some advices for our users that want to report an issue:
|
||
|
||
1. Make sure that you are using the latest version of the Notus Svelte. Check the CHANGELOG from your dashboard on our <a href="https://www.creative-tim.com/?ref=ns-readme" target="_blank">website</a>.
|
||
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
|
||
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
|
||
|
||
## Licensing
|
||
|
||
- Copyright 2021 <a href="https://www.creative-tim.com/?ref=ns-readme" target="_blank">Creative Tim</a>
|
||
|
||
- Licensed under <a href="https://github.com/creativetimofficial/notus-svelte/blob/main/LICENSE.md" target="_blank">MIT</a>
|
||
|
||
## Useful Links
|
||
|
||
- <a href="https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w" target="_blank">Tutorials</a>
|
||
- <a href="https://www.creative-tim.com/affiliates/new?ref=ns-readme" target="_blank">Affiliate Program</a> (earn money)
|
||
- <a href="http://blog.creative-tim.com/?ref=ns-readme" target="_blank">Blog Creative Tim</a>
|
||
- <a href="https://www.creative-tim.com/templates/free?ref=ns-readme" target="_blank">Free Products</a> from Creative Tim
|
||
- <a href="https://www.creative-tim.com/templates/premium?ref=ns-readme" target="_blank">Premium Products</a> from Creative Tim
|
||
- <a href="https://www.creative-tim.com/templates/react?ref=ns-readme" target="_blank">React Products</a> from Creative Tim
|
||
- <a href="https://www.creative-tim.com/templates/angular?ref=ns-readme" target="_blank">Angular Products</a> from Creative Tim
|
||
- <a href="https://www.creative-tim.com/templates/vuejs?ref=ns-readme" target="_blank">VueJS Products</a> from Creative Tim
|
||
- <a href="https://www.creative-tim.com/templates?ref=ns-readme" target="_blank">More products</a> from Creative Tim
|
||
- Check our Bundles <a href="https://www.creative-tim.com/bundles?ref=ns-readme" target="_blank">here</a>
|
||
- Check our awesome builder <a href="https://www.creative-tim.com/builder/argon?ref=ns-readme" target="_blank">here</a>
|
||
- Check Tailwind Starter Kit, the project behind this product <a href="https://www.creative-tim.com/learning-lab/tailwind-starter-kit/presentation?ref=ns-readme" target="_blank">here</a>
|
||
|
||
### Social Media
|
||
|
||
Twitter: <a href="https://twitter.com/CreativeTim" target="_blank">https://twitter.com/CreativeTim</a>
|
||
|
||
Facebook: <a href="https://www.facebook.com/CreativeTim" target="_blank">https://www.facebook.com/CreativeTim</a>
|
||
|
||
Dribbble: <a href="https://dribbble.com/creativetim" target="_blank">https://dribbble.com/creativetim</a>
|
||
|
||
Instagram: <a href="https://www.instagram.com/creativetimofficial/" target="_blank">https://www.instagram.com/creativetimofficial/</a>
|
||
|
||
|
||
## Resources
|
||
- Demo: <a href="https://demos.creative-tim.com/notus-svelte/?ref=ns-readme" target="_blank">https://demos.creative-tim.com/notus-svelte/?ref=ns-readme</a>
|
||
- Download Page: <a href="https://www.creative-tim.com/product/notus-svelte?ref=ns-github-readme" target="_blank">https://www.creative-tim.com/product/notus-svelte</a>
|
||
- Documentation: <a href="https://www.creative-tim.com/learning-lab/tailwind/svelte/overview/notus?ref=ns-readme" target="_blank">https://www.creative-tim.com/learning-lab/tailwind/svelte/overview/notus?ref=ns-readme</a>
|
||
- License Agreement: <a href="https://www.creative-tim.com/license?ref=ns-readme" target="_blank">https://www.creative-tim.com/license?ref=ns-readme</a>
|
||
- Support: <a href="https://www.creative-tim.com/contact-us?ref=ns-readme" target="_blank">https://www.creative-tim.com/contact-us?ref=ns-readme</a>
|
||
- Issues: <a href="https://github.com/creativetimofficial/notus-svelte/issues" target="_blank">Github Issues Page</a>
|