An open API service indexing awesome lists of open source software.

https://github.com/glorious-codes/glorious-pitsby-website

Pitsby Website
https://github.com/glorious-codes/glorious-pitsby-website

Last synced: 4 months ago
JSON representation

Pitsby Website

Awesome Lists containing this project

README

          

# Pitsby Website

## Contributing

1. Install [Node](https://nodejs.org/en/). Download the "Recommend for Most Users" version.

2. Clone the repo:
``` bash
git clone git@github.com:glorious-codes/glorious-pitsby-website.git
```

3. Go to the project directory
``` bash
cd glorious-pitsby-website
```

4. Install the project dependencies
``` bash
npm install
```

5. If you want to just build the project, run:
``` bash
npm run build
```

6. Otherwise, run:
``` bash
npm run start
```

The app will be running on `http://localhost:9000`.

## Tests

1. Ensure that all code that you have added is covered with unit tests:
``` bash
npm run test
```

2. You can optionally generate coverage report after running tests:
``` bash
npm run test -- --coverage
```