https://github.com/tomheaton/mcjty-website
mcjty-website
https://github.com/tomheaton/mcjty-website
docusaurus mcjty minecraft minecraft-mods nextjs tailwindcss typescript wiki
Last synced: 8 months ago
JSON representation
mcjty-website
- Host: GitHub
- URL: https://github.com/tomheaton/mcjty-website
- Owner: tomheaton
- License: mit
- Created: 2022-11-08T15:33:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T10:14:05.000Z (over 1 year ago)
- Last Synced: 2025-04-04T01:41:27.758Z (about 1 year ago)
- Topics: docusaurus, mcjty, minecraft, minecraft-mods, nextjs, tailwindcss, typescript, wiki
- Language: TypeScript
- Homepage: https://mcjty.eu
- Size: 4.52 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# McJty Website
The McJty Website.
Maker of RFTools, McJtyLib, Deep Resonance, and Gear Swapper.
## Project Structure
The project is divided into two main parts:
- [**www**](./www): The main website and wiki.
- [**redirector**](./redirector): The redirector for the McJty website, which is used to redirect requests from the old wiki links to the new website.
## Setup
Make sure you have the correct Node.js version installed (v22).
This can be made easy by using [nvm](https://github.com/nvm-sh/nvm) (or on Windows [nvm-windows](https://github.com/coreybutler/nvm-windows)).
To set the correct node version:
```shell
nvm use
```
Ensure you have [pnpm](https://pnpm.io/) installed:
```shell
npm install -g pnpm
```
To install dependencies, run the following command in the root of the project:
```shell
pnpm install
```
## Formatting
To format all files in the project, run the following command in the root of the project:
```shell
pnpm format
```
## Running Commands
All commands for the sub projects are available in the root `package.json`.
To run a command in a sub project, use the following syntax:
```shell
pnpm www
# or
pnpm redirector
```
For example, to run the `dev` command in the `www` sub project, use:
```shell
pnpm www dev
```