JS library to interact with Forgejo API to work with notifications https://forgejo-notifications-core.docs.forgeflux.org/
Find a file
2023-09-18 20:44:19 +05:30
.reuse feat: init 2023-09-16 15:12:35 +05:30
integration feat: add license headers with reuse 2023-09-18 20:44:19 +05:30
LICENSES feat: init 2023-09-16 15:12:35 +05:30
src feat: add license headers with reuse 2023-09-18 20:44:19 +05:30
.gitignore feat: setup jest and typescript 2023-09-18 17:56:31 +05:30
.nvmrc feat: setup jest and typescript 2023-09-18 17:56:31 +05:30
docker-compose-dev-deps.yml chore & fix: enable CORS to work with Forgejo API 2023-09-18 19:02:09 +05:30
jest.config.ts feat: setup test coverage 2023-09-18 20:27:55 +05:30
Makefile feat: deploy and configure forgejo instance for testing 2023-09-17 01:59:08 +05:30
package.json feat: use typedoc 2023-09-18 20:43:46 +05:30
pnpm-lock.yaml feat: use typedoc 2023-09-18 20:43:46 +05:30
README.md feat: basic docs 2023-09-18 20:44:08 +05:30
setupJest.js fix: enable fetch api in jest 2023-09-18 19:05:53 +05:30

Requires your Forgejo instance admin to enable CORS for at least the origin which serves the notification panel. Please see here for more information.

NOTE: The test forgejo configuration may be insecure for your usecase since it allows CORS for all origins with the widest possible surface.

Build

pnpm install
pnpm run build

Compiled library will be available at ./dist/index.js

Docs

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.

pnpm install
make env.up
make test