https://github.com/chadian/vorfreude
⏳🎉 when you can't wait but have to
https://github.com/chadian/vorfreude
chrome-extension ember-cli glimmerjs typescript
Last synced: 11 months ago
JSON representation
⏳🎉 when you can't wait but have to
- Host: GitHub
- URL: https://github.com/chadian/vorfreude
- Owner: chadian
- Created: 2018-05-13T18:28:17.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-10-07T18:47:04.000Z (over 2 years ago)
- Last Synced: 2025-02-28T13:39:20.636Z (12 months ago)
- Topics: chrome-extension, ember-cli, glimmerjs, typescript
- Language: TypeScript
- Homepage: https://github.com/chadian/vorfreude
- Size: 2.5 MB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ember - vorfreude - When you can't wait but have to. (Packages / Examples Glimmer)
README
## Download
- [Chrome Extension 💾](https://chrome.google.com/webstore/detail/vorfreude/cfdbnmfofkfhbjlabopaepkfdbeajabd)
- [Firefox Add-on 💾](https://addons.mozilla.org/en-US/firefox/addon/vorfreude/?src=search)
## Prerequisites
You will need the following things installed on your computer.
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/) (see package.json "engines" for required version)
- [Yarn](https://yarnpkg.com/en/)
## Installation
- `git clone ` this repository
- `cd vorfreude`
- `yarn`
## Local Development
- `yarn dev`
- Visit the locally running app at the listed outputted in the terminal.
## Tests
- Unit and Component Tests (`yarn test:unit`) use [jest](https://jestjs.io/) and [Testing Library](https://testing-library.com/)
- Acceptance Tests (`yarn test:acceptance`) use [Playwright](https://playwright.dev/)
- Playwright runs tests in the browser and these need to be installed first. This can be done by running `yarn playwright install`
- Both unit/component and acceptance tests can be ran with `yarn test`
### Versioning
1. Create new branch for release.
2. Run `yarn version`
3. Commit changes and push branch
4. Merge PR to `main`
### Building / Package / Release
1. `yarn build` (create build, both svelte and the extension)
2. `yarn package` (create zip package for upload to extension/addon stores)
3. Upload zip to chrome and firefox stores
## Further Reading / Useful Links
- This project is built using [Svelte](https://svelte.dev/) and [SvelteKit](https://kit.svelte.dev/)