An open API service indexing awesome lists of open source software.

https://github.com/uberswe/createmod.com

CreateMod.com website - Non-official Create Mod schematic repository
https://github.com/uberswe/createmod.com

create-mod createmod minecraft schematics website

Last synced: 11 days ago
JSON representation

CreateMod.com website - Non-official Create Mod schematic repository

Awesome Lists containing this project

README

        

# CreateMod.com
[![deploy](https://github.com/uberswe/createmod.com/actions/workflows/deploy.yml/badge.svg)](https://github.com/uberswe/createmod.com/actions/workflows/deploy.yml)

This repository contains all the files needed to run CreateMod.com

To run make sure you have npm and go installed locally and run:
```
cd ./template
npm install
npm run build
cd ..
go run ./cmd/server/main.go serve
```

## Docker

[Docker](https://www.docker.com/) is provided to make local development easier. Use the following command after ensuring that [Docker](https://www.docker.com/) is installed:

```
docker compose up
```

The application will then be available at [http://127.0.0.1:8090](http://127.0.0.1:8090)

The build parameter should be used to rebuild the containers if you are making changes in the Go code.

```
docker compose up --build
```

### NPM

You will need to run `npm install` and `npm run build` to generate the frontend files, you can do this with docker if needed using the following command.

```
docker compose run --remove-orphans npm
```

## Environmental Variables

### Auto Migrate

Auto Migrate can be used to automatically generate database migration files when changes to the data structures are made.

```
AUTO_MIGRATE=true
```

### Create Admin

If Create Admin is set to true an admin is generated. This is convenient for local development.

```
CREATE_ADMIN=true
```

The default credentials are `[email protected]` and `jfq.utb*jda2abg!WCR`. Do not use these credentials in a live environment.

### Dummy data

You can set the following to true to generate dummy data. Please note that it will only work when running the migrations for the first time. Delete the `pb_data` to reset. WARNING this deletes all data.

```
DUMMY_DATA=true
```

### Discord Webhook URL

A webhook url can be specified for Discord notifications

```
DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/122...
```

You can read more about Discord webhooks here: https://discord.com/developers/docs/resources/webhook