Monorepo for the AusSpeedruns.com website.

Table of Contents

• Table of Contents
• Apps
  • NextJS
  • Keystone
• Monorepo
• Setup
• Contributions

Apps

• NextJS (Front-end)
• Keystone (Back end)

NextJS

To run the dev server type the command npm run nextjs or call the nx command nx run nextjs:serve

Keystone

To run the dev server type the command npm run keystone or call the nx command nx run keystone:serve

Monorepo

The monorepo uses Nx.

Keystone is built using a custom builder found in libs/keystone-plugin/src/executors/execurtors.ts.

Setup

To setup the development materials you just need to clone the repo and then run npm install.

Full steps:

git clone https://github.com/AusSpeedruns/ausspeedruns.com.git
cd ausspeedruns.com
npm install

There are a few assets related to sponsors, these require access to a private repo with those assets. The NextJS app will fail without these images, for the time being create a new folder in apps/nextjs/styles/img/ called sponsors and just put a random image in multiple times with the required names the errors are giving you.

Contributions

If you want to help out please message the #new-website channel on the AusSpeedruns discord about what you want to work on! From there we can collaborate on improving the website.