1.0.15 • Published 1 year ago
basecore-cli v1.0.15
baseCore CLI
This is the CLI used to install and manage the baseCore CSS Framework: http://baseco.re
With this CLI you can:
- Download and update baseCore.
- Install baseCore into your project.
- Create new components
Requirements
Node 12v
Installation
You can install it globally
npm i -g basecore-cli
Or use it remotely with npx
npx i basecore-cli [command]
Usage
1. First you need to install baseCore locally in your project:
basecore -i
npx basecore-cli -i
This will download the framework in your node_modules and will extract the components in the src folder:
By now you should have a src folder with everythins installed, you can read al about how baseCore works here: http://baseco.re
3. Creating new components
You can create new componentes like this:
basecore -X <name>
npx basecore-cli -X <name>
X being:
X possible values | Description |
---|---|
-a | Use -a to create an Atom |
-m | Use -m to create a Molecule |
-o | Use -o to create an Organism |
-c | Use -c to create a Cell |
Example
We want to create a new Atom called btn-special, so we do:
basecore -a btn-special
npx basecore-cli -a btn-special
This will create this folder:
src/components/_atoms/_btn-special/
with this files inside
Name | Description |
---|---|
_btn-special.scss | Component visuals |
_btn-special.js | Component logic |
_btn-special.html | Component markup |
_btn-special.md | Markdown document for documentation |
# Testing in localhost
Install it globally with npm i -g basecore-cli
Go to ~/.nvm/versions/node/vxx.x.x/bin/node
ln -s ~/Sites/basecore-cli basecore-cli