Reservoir

Reservoir is a Nuxt website using Vue and NaiveUI backed by the EdgeDB database. It is written for a D&D-like club where players control countries and can trade, war, and interact with each other.

Requirements

• Node.js 18
• EdgeDB 4 (See installation page)

Usage

You can download the latest stable-(ish) version of the code from the releases page. Extract the tar file into a new directory, then run the following commands.

# Check that tools are installed
$ node --version && edgedb --version
v18.19.0
EdgeDB CLI 4.0.2+500be79

# Create and migrate new database
$ edgedb project init

# Run server
$ node ./server/index.mjs
Listening http://[::]:3000

You can visit the deployed website at localhost:3000. You can also update your installation with update.sh.

$ ./update.sh ../reservoir-2.x.x.tar.gz

Contributing

While Reservoir is scoped to the extent that it will be very difficult for new people to add features to it, I still greatly appreciate attempts to improve my code. Pull requests are welcome, but may be denied if they do not fit the scope of the project or are deemed unecessary. Thanks!

Developing the project needs the requirements as listed above.

# Download code locally
$ git clone https://github.com/Phoenix-Wing/Reservoir.git
$ cd Reservoir

# Install dependencies and setup database
$ edgedb project init
$ pnpm i

# Begin development server
$ pnpm dev

You can learn more about developing Nuxt websites with their guide.

Building locally

Run the steps stated previously (except pnpm dev), then do the following:

# Packages all necessary files into reservoir.tar.gz
$ pnpm build