Create Schematics

A site to find and share schematics for the Create mod.

Developing

If you want to contribute to Create Schematics, first of all thank you for your help, but you're going to need to get some things set up first.

First obtain the source

git clone https://github.com/Rabbitminers/Create-Schematics

cd Create-Schematics

Frontend

Our frontend is built with SvelteKit, you'll need to install pnpm and then to start developing run

cd frontend

pnpm install

pnpm run dev

This will start the frontend on localhost:5173 and will automatically reload when you make changes.

Backend

Our backend is built with rust and a postgres database. You'll want to install both rust and docker, or docker compose.

Once you have installed these run

docker-compose up

This will start a development postgres database on port 5432 and redis on port 6379, by default the database name, username and password will all be postgres. And the default url is specified in .env.sample which youll need to rename to .env

From there you can install the sqlx cli in order to set up the database

cargo install sqlx-cli

cd backend

cargo sqlx database setup

Now that you've got everything set up, you're ready to start developing create schematics, to run the server itself run

cargo run server

This will deploy the api itself on localhost:3000

Talk To Us

Have any questions, want to request a feature or found a bug? You can either submit it here on GitHub, or on our Discord Server

Tech Stack

• Front End: Sveltekit, Svelte, Tailwind
• Back End: Rust, Poem, Sqlx
• Database: Postgres

Licenses

Create Schematics is open source, and is licensed under the MIT License, see the License for more information.