- Notifications
You must be signed in to change notification settings - Fork0
arkham-build/api.arkham.build
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Backend forarkham.build.
- The app is a Node.js HTTP API written inTypescript using theHono framework.
- Data is ingested from several upstream sources with a daily cron job, stored in aPostgres database and accessed viakysely. Database migrations are handled withdbmate.
- Kamal is used to deploy the app to aDigital Ocean droplet previously prepared with anAnsible playbook.
- Integration tests useVitest, andTestcontainers to work against a real database.
The original recommendation logic was contributed bySy Brand / TartanLlama in aseparate project and has since been ported over.
It is assumed thatnodejs (22+) anddocker compose are installed.
# install tooling dependenciesnpm i# start docker compose databasesnpm run db:up# run migrationsnpm run dbmate up# ingest datanpm run ingest# start servicenpm run dev
# run testsnpmtest# auto-format codenpm run fmt# lint codenpm run lint# check typesnpm run check
You can find a pre-configuredYaak workspace in./config/yaak.
Refer to availableKamal commands and the additionalaliases in thedeploy.yml file.
About
Backend for arkham.build. Very work-in-progress.
Resources
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
No releases published
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors2
Uh oh!
There was an error while loading.Please reload this page.