From 7fb74814bd7a5ae933e3d06478a0f7bafa0cd581 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Wed, 22 May 2024 18:32:14 +0200 Subject: [PATCH] docs: add minimal docs on how to develop --- development.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 development.md diff --git a/development.md b/development.md new file mode 100644 index 0000000..9fb8b55 --- /dev/null +++ b/development.md @@ -0,0 +1,46 @@ +# Development + +These are internal notes for the development of the project. + +## Installation + +Install dependencies + +```bash +pnpm i +``` + +Setup environment correctly + +```bash +cp .env.example .env +``` + +Look in the usual place for the relevant variables. + +## Running tests + +Before running tests, make sure you load the environment variables from the `.env` file. + +```bash +source .env +``` + +> [!NOTE] +> This is only necessary because I cannot for the life of me find out how to load the environment variables from the `.env` file in the `jest.config.ts` file. + +Then, to run the tests, run + +```bash +pnpm test +``` + +## Publishing + +Just run + +```bash +pnpm publish +``` + +This will create a new release in the `changeset` package.