forgejo-notifications-core/README.md

54 lines
1.3 KiB
Markdown
Raw Normal View History

[![status-badge](https://ci.batsense.net/api/badges/85/status.svg)](https://ci.batsense.net/repos/85)
---
2023-09-19 02:48:32 +05:30
1. Docs: https://forgejo-notifications-core.docs.forgeflux.org/
2. Code coverage: https://forgejo-notifications-core.docs.forgeflux.org/coverage/lcov-report/index
## Dev Notes
2023-09-18 19:04:30 +05:30
Requires your Forgejo instance admin to enable CORS for at least the
origin which serves the notification panel. Please see
[here](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#cors-cors)
for more information.
NOTE: The test [forgejo configuration](./integration/conf/app.ini) may
be insecure for your usecase since it allows CORS for all origins with
the widest possible surface.
2023-09-18 20:44:08 +05:30
## Build
```bash
pnpm install
pnpm run build
```
2023-09-18 20:44:08 +05:30
Compiled library will be available at `./dist/index.js`
## Docs
https://forgejo-notifications-core.docs.forgeflux.org
2023-09-18 20:44:08 +05:30
```bash
pnpm install
pnpm run doc
firefox ./docs/index.html
```
## Tests
There are [scripts][./integration] to setup a Forgejo instance locally,
create [bunch of]./integration/lib.sh) of users, repository and issues
to test all functionality offered by this library. It might be useful to
recreate this environment with `make env.up and ./integration/tests.sh`
for development.
Uses Docker.
2023-09-19 02:48:32 +05:30
2023-09-18 20:44:08 +05:30
```bash
pnpm install
make env.up
make test
```