Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: contributing.md #8

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Contributing

Before contributing please review our [code of conduct](https://github.com/TristanSMP/gateway/blob/main/CODE_OF_CONDUCT.md).

## Setting up a dev environment

### Prerequisites

- Node 16+
- Yarn classic (v1)
- MySQL database
- JDK/Java 17
- Discord dev OAuth app
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discord Application


If you need to modify wings, you should download it [here](https://github.com/TristanSMP/wings/releases).
If there's nothing there, you can download the dev version from [here](https://cdn.tristancamejo.com/tsmp/wings-all.jar).

### Clone the Git repo

```sh
git clone https://github.com/TristanSMP/gateway.git
```

### Environment variables

Fill in your environment variables according to the [`.env.example`](https://github.com/TristanSMP/gateway/blob/main/.env.example).

The `ELYTRA_API_ROOT` environment variable should **not** including a trailing slash.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The `ELYTRA_API_ROOT` environment variable should **not** including a trailing slash.
The `ELYTRA_API_ROOT` environment variable should **not** include a trailing slash.


### Installing dependencies

Make sure you're in the project root, and run:

```sh
yarn
```

### Running the Next.js app

If you haven't already, this is the time to start your MySQL server.
Create a MySQL database user called "tsmp" and grant it all permissions.

```sh
# Push prisma schema to database
# Only needed when schema.prisma is updated or in a new database
yarn prisma db push

yarn dev
```

If everything goes smoothly, you should see the homepage at http://localhost:3000.
Don't worry if you got some errors as you have not configured Wings or the Discord app yet.

If you get a build-time error on the homepage or unable to get it working,
you can visit the #developing-tsmp channel in our [Discord server](https://tristansmp.com/discord).

### Running Wings

WIP

### Configuring Discord app

WIP