README.md

AMD UI

Try it now by clicking here!

Tools (client-side only, no backend):

• Gatsby
• TypeScript
• React
• Emotion
• MUI

🔧 Setup dev environment

Install node v18 or higher, npm v8 or higher, and yarn v1.

⚠️ Note that npm is included in most distributions of node.

💡 If your distribution does not come with the correct node version, one solution is to install nvm and then run nvm use inside the repository clone for every new shell.

# Install dependencies and setup git hooks
yarn

👩‍💻 Develop

# Served at http://localhost:8000
yarn dev

More info: https://www.gatsbyjs.com/docs/reference/gatsby-cli/#develop

📦 Dependency management

More info: yarn cu --help or https://github.com/raineorshine/npm-check-updates

Check for updates

yarn cu

Update package.json dependency keys

yarn up

Then run yarn to update yarn.lock and local node_modules. Commit both changes to package.json and yarn.lock. If you want to start fresh, remove yarn.lock and node_modules, then run yarn.

🏗️ Production build

Build it

yarn build

More info: https://www.gatsbyjs.com/docs/reference/gatsby-cli/#build

Serve it

# Served at http://localhost:9000
yarn serve

More info: https://www.gatsbyjs.com/docs/reference/gatsby-cli/#serve

🧹 Remove cache and production build folders

yarn clean

More info: https://www.gatsbyjs.com/docs/reference/gatsby-cli/#clean

👕 Source linting

More info: yarn lint --help or https://github.com/xojs/xo

Lint sources

yarn lint

Format sources

# NOTE This is run automatically on commit.
yarn lint-and-fix

✔️ Type checking

More info: yarn tc --help or https://www.typescriptlang.org/docs

Once

# NOTE This is run automatically on commit.
yarn tc

Watch mode

yarn tc:watch