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/
61 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 fa1d7427ab
feat: setup packaging
2023-09-19 04:10:21 +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 fix: check_arg 2023-09-19 02:12:39 +05:30
src fix: rm credentials from CORS report 2023-09-19 03:41:59 +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
.swcrc fix: building for web target 2023-09-19 03:11:02 +05:30
.woodpecker.yml feat: CI: publish docs 2023-09-19 01:57:09 +05:30
docker-compose-dev-deps.yml feat: user cors in local dev forgejo 2023-09-19 03:37:09 +05:30
jest.config.ts fix: use testenv in jest to avoid CORS 2023-09-19 01:34:31 +05:30
Makefile feat: publish test coverage 2023-09-19 02:46:49 +05:30
package.json feat: setup packaging 2023-09-19 04:10:21 +05:30
pnpm-lock.yaml feat: update pnpm 2023-09-18 22:09:14 +05:30
README.md feat: add links 2023-09-19 02:48:32 +05:30
setupJest.js fix: enable fetch api in jest 2023-09-18 19:05:53 +05:30
spack.config.js fix: building for web target 2023-09-19 03:11:02 +05:30

README.md

status-badge

  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

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

https://forgejo-notifications-core.docs.forgeflux.org

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