# Github_clava-project-template

**Repository Path**: PanYizhe/Github_clava-project-template

## Basic Information

- **Project Name**: Github_clava-project-template
- **Description**: https://github.com/specs-feup/clava-project-template
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: https://github.com/specs-feup/clava-project-template
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-13
- **Last Updated**: 2026-01-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# clava-project-template

A template for developing projects for Clava in Typescript

## Installing dev environment

Execute the following commands to download all the required code:

```bash
npm install
```

## Compiling and executing Clava-based project

First you need to compile the TypeScript files to JavaScript:

```bash
npm run build
```

Then you can execute your project by running the following on your terminal

```bash
npm run run
```

By default it will run the script `main.ts`. Take a look inside the `scripts` field in the `package.json` file for more information.

You can also run tests, get test coverage information and generate documentation for your project.

## Debugging

You can get debugging information using a `DEBUG` environment variable.
This variable is used by the [debug](https://www.npmjs.com/package/debug) module to determine what to expose.

```bash
DEBUG="*" npm run run
```