Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/5am-code/sunrise
Sunrise is a Vue component library. It's based on TailwindCSS and focused on minimal, expressive design, inspired by the beautiful colors of the sunrise. The components are slightly opinionated, but very flexible, so integrate them as you need. Have fun!
https://github.com/5am-code/sunrise
tailwind typescript vue
Last synced: about 1 month ago
JSON representation
Sunrise is a Vue component library. It's based on TailwindCSS and focused on minimal, expressive design, inspired by the beautiful colors of the sunrise. The components are slightly opinionated, but very flexible, so integrate them as you need. Have fun!
- Host: GitHub
- URL: https://github.com/5am-code/sunrise
- Owner: 5am-code
- License: gpl-3.0
- Created: 2020-11-23T22:08:10.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-08T07:12:40.000Z (over 2 years ago)
- Last Synced: 2024-05-20T22:40:43.246Z (7 months ago)
- Topics: tailwind, typescript, vue
- Language: Vue
- Homepage: http://sunrise.5amco.de
- Size: 94.7 KB
- Stars: 43
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sunrise Components
This is another component library. You can use it with Vue.
```
It's build with the power of the inspiring sunrises I experienced
whenever I woke up at 5 am. Often it was build around 5am...
So beautiful, so inspiring, blah blah.
I need coffee.
```
Have fun!
---
So, let's get serious.
Sunrise by 5amco.de is a Vue component library written in Typescript. It's based on TailwindCSS and focused on minimal, beautiful design. You can use the growing number of components as a standalone library or extend your existing application design - Sunrise Components are lightly opinionated, but very flexible. For detailed used information, see the documentation on the website.
## Usage
### Prerequisites
Have your **Vue project up and running on Typescript**! For the sake of completeness: You will need the packages `vue-property-decorator` as well as
`vue-class-component`, but these should already come with your Vue Installation.
Next up, you should install and setup Tailwind via npm like described in
their docs. After that, if you haven't done it yet, you should create a
Tailwind configuration file - this is also well documented in the
documentation. Sunrise is using handcrafted, custom colors for the unique
design, so please extend (or merge) your Tailwind configuration file with
the configuration below.
And a sip of your favorite hot beverage is always a great idea. ☕️ 🍵
### via npm
The easiest way to use Sunrise Components is to install via npm.
```
npm i @5amcode/sunrise-components --save
```
#### Adjust `tailwind.config.js`
After this, you should extend your own `tailwind.config.js` by the configuration given in the file `extend_tailwind.config.js`. It is located in the root of the package. This configuration contains the custom colors, additional utility classes and more.
(You can also take a look at the file in the [Usage Section](https://sunrise.5amco.de/usage) on the package website.)
If you want to use the full Sunrise Design - and we highly recommend this! - note that you have to install or embed the Fonts [Open Sans](https://fonts.google.com/specimen/Open+Sans) (used as standard font), [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+Pro) (headlines) and [Source Serif Pro](https://fonts.google.com/specimen/Source+Serif+Pro) (oblique, fancy text stuff ✨). As of today, the usage of the fonts is free, but you should double-check with your own requirements before installing them. You can use your own fonts as well, just tweak the font-properties in your `tailwind.config.js`:
```
...
// theme fonts
fontFamily: {
'display': ["'Source Sans Pro'"], // headlines
'sans': ["'Open Sans'"], // standard text
'oblique': ["'Source Serif Pro'"], // oblique, fancy text
},
...
```
Recompile your CSS and you're done! 🚀
#### Icons
Sunrise uses the SVG versions of [Heroicons](https://heroicons.com/) for a clean look and feel. If you're using Fontawesome or another icon set, replace the icons in the following components to match yours: `STypoQuote.vue`.
### Copy & Paste
This is the best approach if you don't need all components of the package.
You can copy the source code of the components you want and create them as own files in your Vue project. Please note that you still have to extend your `tailwind.config.js` file for correct rendering (see section above).
### Questions, bug reports, feature requests?
There you [go](https://github.com/5am-code/sunrise/issues)!