realaravinth/forgejo-notifications-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
JS library to interact with Forgejo API to work with notifications https://forgejo-notifications-core.docs.forgeflux.org/
49 commits 2 branches 0 tags 316 KiB
Python 44.1%
TypeScript 30.1%
Shell 23%
Makefile 2.4%
JavaScript 0.4%
Find a file
Aravinth Manivannan 0c9f907b80
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
Details
feat: CI: publish docs
2023-09-19 01:57:09 +05:30
.reuse feat: init 2023-09-16 15:12:35 +05:30
integration chore: rm sleep and curl debugs 2023-09-19 01:55:45 +05:30
LICENSES feat: init 2023-09-16 15:12:35 +05:30
scripts feat: CI: publish docs 2023-09-19 01:57:09 +05:30
src fix: port issue test 2023-09-19 01:33:45 +05:30
.gitignore fix: use tmp/ instead of secrets/ 2023-09-18 22:30:02 +05:30
.nvmrc feat: setup jest and typescript 2023-09-18 17:56:31 +05:30
.woodpecker.yml feat: CI: publish docs 2023-09-19 01:57:09 +05:30
docker-compose-dev-deps.yml fix: rm file mode from docker compose 2023-09-18 21:47:21 +05:30
jest.config.ts fix: use testenv in jest to avoid CORS 2023-09-19 01:34:31 +05:30
Makefile feat: CI: publish docs 2023-09-19 01:57:09 +05:30
package.json feat: use typedoc 2023-09-18 20:43:46 +05:30
pnpm-lock.yaml feat: update pnpm 2023-09-18 22:09:14 +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

README.md

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