README.md

EOS Costa Rica standard theme

At EOS Costa Rica we believe is important to have a standard theme across our several projects, that will allow us a faster developments of our web apps and at the same time it's availabe for anyone who will want to use it.

Instalation

$ npm i -S @eoscostarica/eoscr-theme

If you prefer to use yarn:

$ yarn add @eoscostarica/eoscr-theme

Note: if you're reading this from Github Packages, yarn is not supported yet. You can see the entire list of supported package managers right here.

Usage

import { EOSCR_THEME } from "@eoscostarica/eoscr-theme";
...
...
let primaryColor = EOSCR_THEME.colors.primary.base;

Project structure

├── dist
├── src
|  ├── index.ts
├── test 
├── package.json
├── README.md
└── tsconfig.json

Theme's object general structure

EOSCR_THEME
├── palette
|   ├── primary
|   |   ├── ...
|   |   secondary
|   |   ├── ...
├── typography
|   ├── fontFamily
|   |   ├── ...
|   ├── h1
|   |   ├── ...
|   ├── h2
|   |   ├── ...
|   ├── ...
|   |   ├── ...

You can see the entire raw file here.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

JustinCast 💻 📖 📆 🚧

Jorge Murillo 🎨

Xavier Fernandez 👀

This project follows the all-contributors specification. Contributions of any kind welcome!