Skip to main content

Installation

Requirements​

  • Node.js version 18.0 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed. When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Scaffold a new project​

To create a new project, you can use the following command:

npx create-sonnet-project

You will be prompted to enter the project name, select a template, and choose whether to add TypeScript to the project. Here is an example of the prompts:

Sonnet JS: A frontend framework

✔ Project name: … sonnet-project
✔ Select a template › Default
✔ Add TypeScript? … No / Yes

  cd sonnet-project
  npm install
  npm run dev

This will create a new Sonnet JS project in the sonnet-project directory and install all the necessary dependencies.

Running the project​

To run the project, you can use the following command:

npm run dev

This will start the development server and open the project in your default browser.

Building the project​

To build the project, you can use the following command:

npm run build

This will create a production build of the project in the dist directory.

Running the production build​

To run the production build, you can use the following command:

npm run serve

This will start a production server and open the project in your default browser.

Project structure​

The project structure will look like this:

sonnet-project
├── dist
├── node_modules
├── public
├── src
│   ├── main.ts
│   ├── App.ts
│   └── Counter.ts
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json
  • dist: Contains the production build of the project.
  • node_modules: Contains all the dependencies of the project.
  • public: Contains the public assets of the project.
  • src: Contains the source code of the project.
    • main.ts: The entry point of the project.
    • App.ts: The main component of the project.
    • Counter.ts: A sample component.
  • .gitignore: Contains the files and directories that should be ignored by Git.
  • package.json: Contains the metadata of the project.
  • README.md: Contains the documentation of the project.
  • tsconfig.json: Contains the TypeScript configuration of the project.