Getting Started

  1. Be sure you have Grunt and Node.js installed. On Windows, also install a Bash shell such as the one that comes with Git.
  2. Grab a copy of Core UI:
    1. Fork Core UI to create your own repository
    2. Alternatively, you may add Core to an existing project by downloading the latest release and unzipping it to your folder or by running git clone https://github.com/ny/coreui.git from a command line
  3. Add your project files to the /src/project/ folder (more details)
  4. Open a command line and type npm install to install the necessary Node modules for building the project
  5. At the command line type grunt to build the project

You will now have a /dist/ folder which contains all of the CSS, JS, images, and fonts ready for deployment.

From here you may want to start adding components or dive into the other available grunt tasks.