https://github.com/jmcdo29/unteris
Unteris is a TTRP homebrew setting filled with cults, ancient magic, and deities. This is the source code for the website and server
https://github.com/jmcdo29/unteris
caddy docker kysely nest-commander nestjs nx react
Last synced: 10 months ago
JSON representation
Unteris is a TTRP homebrew setting filled with cults, ancient magic, and deities. This is the source code for the website and server
- Host: GitHub
- URL: https://github.com/jmcdo29/unteris
- Owner: jmcdo29
- License: mit
- Created: 2023-04-01T16:21:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-16T00:50:11.000Z (over 1 year ago)
- Last Synced: 2025-04-24T04:03:36.770Z (about 1 year ago)
- Topics: caddy, docker, kysely, nest-commander, nestjs, nx, react
- Language: TypeScript
- Homepage: https://unteris.com
- Size: 28.8 MB
- Stars: 47
- Watchers: 2
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unteris
This project was generated using [Nx](https://nx.dev).
## Welcome to the World
Unteris is a D&D Homebrew setting written and developed by my partner. All
credit for information about the world goes to them. This repository is the
website that I am working on for displaying the information they come up with
to make it easier to track changes, and share the information with other
players and Dungeon Masters as the campaign setting grows.
## The (Code) Design
Currently, the front end is being written in React while using NestJS as the
server side framework all withhin this wonderful Nx monorepo. nest-commander is
being used as a CLI builder to integrate with Kysely to handle migrations via
its own "application" in Nx's terms. Migrations are written to their own
library directory, and all new react components go into separate libraries as
well to help keep builds short making use of Nx's computational caching.
Currently hosted via a banana pi in my office.
## Running Locally
If you **really** can't wait to see what this is all doing you can follow th
steps below
### Prereqs
1. NodeJS preferrably current (18 and above)
2. A package manager, I use pnpm and do not guarantee yarn or npm will work the
same
3. Docker-compose
4. Your own creativity when it comes to filling in the database as those seeds
are not yet created
### Steps
1. Clone the repo and move to the directory
2. Run `docker compose up -d` to start the database
3. Run `pnpm nx run kysely-cli:migrate` to build and run the migrations
4. Run `pnpm nx run server:serve` to start the server on port 3333
5. Run `pnpm nx run site:serve` to start the site on port 4200
## Keep in Touch
I'll be working on this in the free time that I have, as I really want to see
it all come together. Feel free to use this project as inspiration for your own
or learn how I'm connecting Nx libraries and applications together. Otherwise,
you can just watch the project and see what becomes of it.
Any major questions I guess you can raise an issue or [email me about it][email]
[email]: mailto://dev@unteris.com