Static Website Setup
How to setup static website with Chisel
1. Create project directory
Create a new project directory and change your working directory to it. You can use the following commands on the command line:
mkdir project-name cd project-name
2. Run Chisel
Run Chisel from the project directory
Insert project name (you can use the default one based on the working directory name), author, and select Front-end Templates project type. Select browsers you're supporting, optional additional features (see below) and wait until the installation completes.
Additional features are available during installation, they can be also enabled later in
- Serve dist directory in dev / don't generate pages index: by default chisel generates index page with pages you create outside of the dist directory, this may be useful when you're working on static templates that somebody will later work on (for example different developer will integrate with backend). If you're working on a website that'll be deployed from the Chisel project it's probably good to enable this to match dev server behavior with the deployed site.
- Don't include html extension in links (posts API) & support them in dev: When enabled dev server will support urls without html extension. Additionally, when working with content html extension will be omitted from generated links.
To speed up the installation process we recommend using Yarn. Chisel will automatically detect it and run if possible. Otherwise, it falls back to the default NPM install
3. Setting up an existing project
If you are joining the development of an existing front-end project which was already set up with Chisel, you don't have to set it up again. Follow these steps:
- Clone repository
npm run buildand
npm run dev