-
-
Notifications
You must be signed in to change notification settings - Fork 2
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
GodderE2D
wants to merge
1
commit into
main
Choose a base branch
from
GodderE2D-patch-contributing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||||||
|
||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
### 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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discord Application