# Contributing

Thanks for taking the time to contribute to this project!

## How to help?

There are multiple tasks you can do in order to help us, for example:
- fill an issue to report bugs or your specific needs
- contribute to existing issue
- write a PR to improve the project

## Repository structure

All the important files are in the src directory.

## Set up

```shell
$ git clone https://github.com/BetaHuhn/ejs-serve && cd ejs-serve
$ npm install
```

## Commands
### Linting

[ESlint](https://eslint.org/) is used for linting. It's recommended to add the corresponding extension to your editor. It's also possible to run the `lint` task with the following command: 
```shell
$ npm run lint
```

### Local testing 

Run `npm link` to install the library locally and make the command `ejs-serve` available to your user.

### Run example

Run `npm run example` or `yarn example` to serve the template located in the `example` directory