Commit ff63fdf5 authored by Grant's avatar Grant
Browse files

handoff implementation & docs

parent 3b5068ed

.env.example

0 → 100644
+4 −0
Original line number Diff line number Diff line 
FEDIVERSE_AUTH_HOST=https://auth.host.example

PORT=3001



DATABASE_URL="postgresql://postgres@localhost:5432/fedievents-api?schema=public"
 
 No newline at end of file

.gitignore

+2 −1
Original line number Diff line number Diff line
@@ -35,3 +35,4 @@ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json 


# dynamicly generated files

src/types/openapi.d.ts

/src/generated/prisma

.gitlab-ci.yml

+8 −0
Original line number Diff line number Diff line
@@ -12,3 +12,11 @@ pages: 
      - public

  rules:

    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH



build wiki:

  stage: build

  trigger:

    include: .gitlab/ci/wiki.yml

  allow_failure: true

  rules:

    - if: $CI_PIPELINE_SOURCE != "merge_request_event" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

.gitlab/ci/wiki.yml

0 → 100644
+14 −0
Original line number Diff line number Diff line 
build-wiki:

  image: alpine

  stage: build

  before_script:

    - apk add --no-cache git git-subtree

  script:

    - git config user.email "ci@sc07.company"

    - git config user.name "ci"

    - git remote remove gitlab-wiki || true

    - git remote add gitlab-wiki "https://ci:$CI_TOKEN@sc07.dev/fediverse.events/fediverse.events-api.wiki.git"

    - git status

    - git checkout main

    - git pull

    - git push gitlab-wiki `git subtree split -P doc main`:main --force

README.md

+12 −10
Original line number Diff line number Diff line 
# fediverse.events-api

# Fediverse Events API



To install dependencies:

This repository contains both the documentation and a reference implementation of the server



```bash

bun install

```

## [Documentation](https://sc07.dev/fediverse.events/fediverse.events-api/-/wikis)



To run:

The documentation can be viewed using the GitLab wiki or via the `/doc` folder in the repo



```bash

bun run index.ts

```

Contributing to the wiki can be done by pushing to the `/doc` folder



This project was created using `bun init` in bun v1.2.11. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
 
[View OpenAPI Spec](https://sc07.dev/fediverse.events/fediverse.events-api/-/blob/main/openapi/openapi.yaml)



## Server Development

* `bun install --include=dev`

* `bunx prisma generate`

* `bun dev:api-ts`

* `bun dev`
 
 No newline at end of file