Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.34 KB

README.md

File metadata and controls

24 lines (17 loc) · 1.34 KB

Karbon Starter Template

This is a repo storing starter templates for Karbon projects, which allows users to quickly start a new Karbon project.

Available Templates

  • default: A prebuild template for Karbon projects.
  • scratch: A blank template for Karbon projects.

How to Use

Using this template is very simple, just follow these steps:

  1. Run npm init @storipress/karbon <template-name> <project-name> to create a new project.
  2. Copy the .env.example file and rename it to .env, then fill in the Storipress API related information in the .env file.
  3. In the terminal, run yarn install to install the required packages for the project.
  4. In the terminal, run yarn dev to start editing the webpage.

License

This template uses the MIT license. See the LICENSE file in the project for more information.