CONTRIBUTING.md

undb is built with nodejs for backend and sveltekit for frontend, it only requires nodejs to be installed on your local machine, it's very easy to start with development.

Prerequisite

• Node.js, required version >= 20.6.1
• pnpm, package management for undb, required version >= 8.0.0

Setup steps

Clone repo

git clone git@github.com:undb-xyz/undb.git

Setup environment (Optional)

undb suggest using fnm to setup proper node version

fnm use

you can also use some other node version manager like nvm or n or volta

Bootstrap (Optional)

If you are first time to run undb, you should run bootstrap script.

pnpm run bootstrap

note that if you are using some other node package manager like npm or yarn, it will throw an exception

Run dev script

pnpm run dev