@eternal-twin/hammerfest-archive-pg

Eternal-Twin `HammerfestArchiveService` Postgres implementation

Usage no npm install needed!

<script type="module">
  import eternalTwinHammerfestArchivePg from 'https://cdn.skypack.dev/@eternal-twin/hammerfest-archive-pg';
</script>

README

Eternal-Twin main repository

Getting started

cp etwin.toml.example etwin.toml
yarn install
yarn start

The commands above will install the dependencies, compile the website and start it. By default, the website starts with an in-memory backend implementation that does not require a database.

See DB documentation to install and configure a Postgres database, then run yarn run db:create or import a database.

Project tasks

This repository uses yarn to run project-related tasks such as building or testing.

The tasks are defined in the scripts field of package.json, you can run them with yarn run <taskname> (or yarn <taskname> if there is no ambiguity with existing yarn commands).

The website package has more advanced tasks described in its README.md, all the other packages have the same structure and tasks:

  • yarn build: Compile the library
  • yarn test: Compile the tests and run them
  • yarn lint: Check for common errors and style issues.
  • yarn format: Attempt to fix style issues automatically.

Configuration

The website is configured using a local etwin.toml file. You can copy etwin.toml.example and edit its values. The different configuration parameters are commented in etwin.toml.example.

Wiki

Partially Outdated: See wiki and README.md files in package directories for help.