juke-fr/.README.template.md

40 lines
908 B
Markdown

## instructioms
![jinx the cat my beolved](components/assets/jinx.png)
### repository
the latest automatic release is always on https://juke.fr
```bash
$ git clone https://code.juke.fr/kay/juke-fr.git
$ npm i
$ npm run dev
```
### test suite
playwright is used for testing
```bash
$ npm run test:setup # only needed once to download the browsers
$ npm run test
```
playwright is cool because it gives you traces with screenshots you can go through step by step so yeah
### tested upgrade
the test suite can be used with npm-check-updates to mass upgrade the node modules and make sure stuff still (at least somewhat) works
might want to disable a couple browsers and only leave 1 for it to be faster
```bash
$ npm run tested-upgrade
```
it will upgrade all the packages then run the test and do them one by one incrementally if that fails and not do any of the ones that makes the tests fail