A Growtopia private server built with Node.js and Bun.js, powered by growtopia.js

Note

This source is not production ready yet. In the future it will be using a Docker to deploy the server, feel free to join Discord Server to discuss regarding this.

Requirements

• Node.js v20+ or Bun.js v1.2.9+
• pnpm v10
• mkcert
• docker
• docker-compose (required)

Setup

To setup the server, first install necessary packages & settings by

$ pnpm install
$ pnpm run setup

And congrats setup are done, simple as that! Now you just need to run the server by

Note

It must be running PostgreSQL & Redis in background by using docker, please navigate to docker guide

$ pnpm run dev

Database

Database that we moved to PostgreSQL from previous database SQLite. And for the ORM we are using Drizzle-ORM

To view the database you can run this command below:

$ pnpm run studio

and access it on here https://local.drizzle.studio/

Starting server

To run the development server by

$ pnpm run start

Development

In order to make new login system work you need to install mkcert on this download page (I'd recommend using Lets encrypt for production only)

Local CA installation

Install the mkcert local CA by

$ mkcert -install

Hosts

For the hosts file you can see this example below

127.0.0.1 www.growtopia1.com
127.0.0.1 www.growtopia2.com
127.0.0.1 login.growserver.app # New login system for development purposes

Docker

To run the dockerized & running it automatically just run

docker compose up -d

or you want to run the database & redis only (this were for development only) then simply running

docker compose up -d db redis

Contributing

Any contributions are welcome.

There's few rules of contributing:

• Code must match the existing code style. Please make sure to run pnpm run lint before submiting a PR.
• The commit must take review first before merging into main branch.

Links

• Discord Server

Contributors

Give a thumbs to these cool contributors: