The fastest way to get your idea up and running with Cirrus.
- 💎 Direct integration with Cirrus using Sass configuration. This allows you to customize what features you want in Cirrus and which classes to add/remove during project generation.
- ⚙️ Bundled with Webpack to bundle all your assets in a fast and configurable manner. This includes a few standard Webpack plugins and a live reload server for fast iteration.
- ⚗️ PurgeCSS included by default to minimize build sizes and remove all Cirrus classes that are not used for builds.
- ⚡ Deploy and tear down your project with ease with Surge.sh.
To get started, clone or download the project.
After installing locally, open up the cirrus-start
folder in your favorite text-editor/IDE.
Yarn
yarn
or
yarn install
Npm
npm install
Make the changes you want within the project and then run locally with the following commands:
yarn build
- build project indevelopment
mode.yarn watch
- build on save without live server.yarn serve
- start project with live server.yarn serve:hot
- build on save with live server refresh and automatically open the project onlocalhost
.
For npm, replace yarn
with npm
.
After starting the project, the dev serve should be running on http://localhost:9000
. This port number can be updated inside webpack.config.js
.
To create the production build of your project, run the following command:
Yarn
yarn build:prod
Npm
npm run build:prod
Project deployment is powered by Surge.sh, a fast way for developers to launch their front-end project. All projects are given a free *.surge.sh
domain. Custom domains can be set with a paid plan.
Yarn
yarn deploy
Npm
npm deploy
Simply follow the prompts after entering the above command.
To update your existing deployment, use the redeploy
command and specify the domain you used.
yarn deploy my-project.surge.sh
Npm
npm deploy my-project.surge.sh
Once you no longer need it deployed, use the teardown
comand to remove your project's deployment.
yarn teardown
Npm
npm teardown
Read our contributing guide and improve Cirrus together.
We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues.
When creating issues, please follow the templates provided for the issue type you selected. The added detail and formatting will help me understand and resolve your issue faster.
I would greatly appreciate any support for the continued development of this project. 😄