feat: basic docs

This commit is contained in:
Aravinth Manivannan 2023-09-18 20:44:08 +05:30
parent 586654fcf2
commit 53a21b7c4a
Signed by: realaravinth
GPG key ID: F8F50389936984FF

View file

@ -6,3 +6,35 @@ for more information.
NOTE: The test [forgejo configuration](./integration/conf/app.ini) may NOTE: The test [forgejo configuration](./integration/conf/app.ini) may
be insecure for your usecase since it allows CORS for all origins with be insecure for your usecase since it allows CORS for all origins with
the widest possible surface. the widest possible surface.
## Build
```bash
pnpm install
pnpm run build
```
Compiled library will be available at `./dist/index.js`
## Docs
```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.
```bash
pnpm install
make env.up
make test
```