https://github.com/luetkemj/aglet-timekeeper
A simple timekeeper for tabletop RPGs
https://github.com/luetkemj/aglet-timekeeper
babel node react redux webpack
Last synced: 5 months ago
JSON representation
A simple timekeeper for tabletop RPGs
- Host: GitHub
- URL: https://github.com/luetkemj/aglet-timekeeper
- Owner: luetkemj
- License: mit
- Created: 2017-08-01T23:42:26.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-03-12T18:38:39.000Z (over 4 years ago)
- Last Synced: 2023-03-24T20:02:33.541Z (about 3 years ago)
- Topics: babel, node, react, redux, webpack
- Language: SCSS
- Homepage:
- Size: 250 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
# Aglet Timekeeper
A simple timekeeper for tabletop RPGs
[Live demo](http://aglet.io/tools/timekeeper/)
## Installing / Getting started
This project requires [Node.js](https://nodejs.org/en/). Ensure that you have the latest version installed before continuing.
This project uses a webpack server with hot module replacement for development.
Clone repo: `git clone git@github.com:luetkemj/aglet-timekeeper.git`
Install dependencies: `yarn` or `npm install`
Start the server: `npm start`
Navigate to `localhost:3000`
### Building
This project uses babel to transpile all javascript to es5 syntax and webpack to build a dist directory for deployment.
Build for production: `npm run build`
Running the build script will remove the existing build directory, run all code linting and tests, and run webpack to build an es5 transpiled, uglified, bundle located in the dist directory.
## Tests
This project uses jest for unit tests, code coverage reports, and component snap shots.
To run tests in watch mode: `npm run test:watch`
To run lint all code and run all tests: `npm run test`
## Style guide
This project uses [eslint-airbnb](https://www.npmjs.com/package/eslint-config-airbnb). Custom rules can be found in the [.eslintrc](https://github.com/luetkemj/aglet-timekeeper/blob/master/.eslintrc) file included in this project.
eslint: `npm run lint:eslint`
This project uses [sass-lint](https://github.com/sasstools/sass-lint). Custom rules can be found in the [.sass-lint.yml](https://github.com/luetkemj/aglet-timekeeper/blob/master/.sass-lint.yml) file included in this project.
sass-lint `npm run lint:sass-lint`
eslint and sass-lint: `npm run lint`
## Contributing
Contributions are welcome.
Find a bug? Open an [issue](https://github.com/luetkemj/aglet-timekeeper/issues)!
Working on your first Pull Request? You can learn how from this free series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
## Licensing
[MIT License](https://github.com/luetkemj/aglet-timekeeper/blob/master/LICENSE)