Module Showcase Website
Keeping track of Terasology's modules since 2019.
About The Project
Terasology’s basic engine can be extended by a huge amount (201 right now!) of modules. Keeping track of them is not the easiest task. This is why this gatsby framework provides an automated generator for a website, listing all of them. This showcase website will increase discoverability by allowing to filter and search for modules by keywords and categories.
Getting Started
The module website development environment can be installed on macOS, Windows, and Linux (Debian or Ubuntu recommended). You’ll need at least 1GB of available RAM.
Prerequisites
This website is built with Gatsby. The following tools must be installed to build and serve the website locally:
Development
Make sure that you fulfill the prerequisites for building the website locally
To install all dependencies, run
yarn install
You can then use the Gatsby CLI commands build
, clean
, develop
and serve
.
Our custom source plugin fetches information from GitHub, and therefore needs a GitHub personal access token in the environment named GITHUB_TOKEN
.
If the token expires, you can follow the "How to fix an expired GitHub Action token" instructions with the following adjustments:
- the token required for the custom source plugin does not require additional scopes, which means you can skip step 2
- steps 4 and 5 should be performed in the ModuleSite repository settings on the
MODULE_FETCH_GITHUB_TOKEN
secret
To build the website, run
yarn run build
To serve the website from a previous build, run
yarn run serve
To compile and serve a preview of the website that reflects your source code changes in the browser in real time, run
yarn run develop
To clean up built assets and caches, run
yarn run clean
To learn more about the project structure and working of the project please refer to our docs.
Contributing
To add a new feature or fix a bug follow the steps -
- Make sure your local workspace is up-to-date with the main repository.
- Fetch the latest code
git fetch upstream
- Checkout to your local master branch
git checkout master
- Merge changes from
upstream/master
to syncgit merge upstream/master
- Fetch the latest code
- Create a new branch to work on the new feature or bug via the updated master branch
git checkout -b "branch_name"
- Work on feature/bug and stage all the files to commit it on that branch
git add .
>git commit -m "Commit Message"
- Push the branch to your fork
git push -u origin branch_name
- Create a pull request.
Contributors
A list of contributors can be found here.