rae/mipilin
rae/mipilin
1
0
Fork 0
mirror of https://git.sr.ht/~roxwize/mipilin synced 2025-05-11 15:53:07 +00:00
Code Issues Activity

compilation

Browse source 
Signed-off-by: roxwize <rae@roxwize.xyz>
This commit is contained in:
Rae 5e 2025-01-29 21:49:47 -05:00
parent dfd27154cd
commit a2e568e751
Signed by: rae
GPG key ID: 5B1A0FAB9BAB81EE
5 changed files with 79 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -6,3 +6,32 @@
mipilin **mipilin**
![website screenshot](./screenshot.png)
## Running locally
```sh
## get repository
git clone https://git.sr.ht/~roxwize/mipilin
cd mipilin
## setup environment variables
cp .env.example .env
$EDITOR .env # If $EDITOR is not set, replace it with your text editor of choice
## start server
pnpm install
pnpm build # Compile TypeScript files to JavaScript in ./dist/
pnpm start
```
You can also run the server's TypeScript directly by using `pnpm dev`.
### Environment variables
Keep your `.env` file to yourself. The only non-sensitive field is `LISTEN_ON_SOCKET`.
| Variable | Description | Required |
| -------- | ----------- | -------- |
| `LISTEN_ON_SOCKET` | If set to `true` the server will run on a Unix socket at `/run/user/[UUID]/mipilin/mipilin.sock` | no |
| `DATABASE_URL` | URL where your PostgresQL database will be accessed | **yes** |
| `COOKIE_SECRET` | Can be any string, used to sign cookies | **yes** |