README.md

Welcome

Welcome to the GameCI documentation repo! Here you will find the documentation assets for GameCI and it's related open-source projects. The live documentation site available at game.ci.

You may also view the markdown files directly at the following links:

• Getting Started with GameCI
• GitHub Actions
• GitLab Pipelines
• CircleCi
• Docker
• GitHub Cloud Runner
• Troubleshooting
• FAQ

Building the Docs Site

Built with Docusaurus 2.

This project has a hard dependency on Node16. You will need to make sure that you have the proper version of node installed to avoid errors.

• Install NodeJS v18 on Ubuntu
• Install NodeJS v18 using brew

This project relies on yarn for package management. You will need to install yarn in order to build and test the documentation site.

• Official yarn installation docs.

1. Install project dependencies

   yarn install

2. Start a local development server

   This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

   yarn start

3. Create a build This command generates static content into the build directory and can be served using any static contents hosting service.

   yarn build

Meet the Community

Join us on Discord and engage with the growing community of engineers, artists, hobbyists, and professionals using GameCI to build, test, and publish their projects everyday.

Support the Team

GameCI is free for everyone forever. You can support the people who make GameCI possible on OpenCollective

License

This repository is MIT licensed. This includes all contributions from the community.