https://github.com/glorious-codes/glorious-pitsby-demo
Pitsby live demonstration
https://github.com/glorious-codes/glorious-pitsby-demo
Last synced: 4 months ago
JSON representation
Pitsby live demonstration
- Host: GitHub
- URL: https://github.com/glorious-codes/glorious-pitsby-demo
- Owner: glorious-codes
- Created: 2020-03-06T19:18:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-26T01:24:07.000Z (about 2 years ago)
- Last Synced: 2025-05-05T19:53:52.144Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://pitsby-demo.compilorama.com
- Size: 6.77 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Glorious Pitsby Demo
> Demo documentation generated with https://pitsby.compilorama.com
[](https://circleci.com/gh/glorious-codes/glorious-pitsby-demo/tree/master)
[](https://coveralls.io/github/glorious-codes/glorious-pitsby-demo?branch=master)
## 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-demo.git
```
3. Go to the project directory
``` bash
cd glorious-pitsby-demo
```
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:7000`.
## 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
```