https://github.com/fildon/shiny-measure

https://github.com/fildon/shiny-measure

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/fildon/shiny-measure
• Owner: fildon
• Created: 2021-10-03T18:32:37.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-22T13:58:13.000Z (over 1 year ago)
• Last Synced: 2025-01-19T20:17:56.128Z (over 1 year ago)
• Language: TypeScript
• Size: 917 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Shiny Measure

[![Build](https://github.com/fildon/shiny-measure/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/fildon/shiny-measure/actions/workflows/deploy.yml)

[![Test](https://github.com/fildon/shiny-measure/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/fildon/shiny-measure/actions/workflows/test.yml)

My personal fitness app. Hosted at [fildon.me/shiny-measure](https://fildon.me/shiny-measure).

All data is only held in localStorage.

## Developer Guidance

1. Install dependencies

   ```shell

   npm install

   ```

2. Build the app

   ```shell

   npm run build

   ```

3. Serve locally

   ```shell

   npm run serve

   ```

You will now have a running application at localhost:5000

## Linting

Linting is provided by ESLint, and run with

```shell

npm run lint

```

## Testing

Testing is provided by Jest, and run with

```shell

npm run test

```

## Deployment

Deployment is handled automatically via Github Actions.

Any update to the `main` branch will trigger a new build and deploy.

## Contributing

Contributions are always welcome!

Please begin by raising or commenting on a GitHub issue.

Then feel free to open a PR.

For any TypeScript changes, tests must be included.