trackjs / javascript-gameshow

Getting Started with Contributing to javascript-gameshow on trackjs

Before diving into contributing to the javascript-gameshow project on TrackJS, it’s essential to familiarize yourself with the project setup, development workflow, and contributing guidelines. In this guide, we’ll walk you through the process of setting up your development environment, understanding the project structure, and making your first contribution.

Prerequisites

To contribute to the javascript-gameshow project, you’ll need the following tools installed:

  1. Node.js: Download and install Node.js from the official website.
  2. Git: If you don’t have Git installed, download it from the official website.
  3. Preact CLI: Install the Preact CLI globally using npm install -g create-preact-app.

Cloning the Repository

Clone the javascript-gameshow repository using Git:

git clone https://github.com/trackjs/javascript-gameshow.git

Navigate into the project directory:

cd javascript-gameshow

Setting Up the Development Environment

To set up the development environment, use the following command:

npm install

This command installs all the dependencies listed in the package.json file.

Understanding the Project Structure

The javascript-gameshow project is built using Preact, a fast, component-based JavaScript library for building web applications. The project structure is as follows:

javascript-gameshow/
├── node_modules/
├── public/
├── src/
│   ├── components/
│   ├── database.template.json
│   ├── index.html
│   ├── index.ts
│   └── serviceWorker.ts
└── package.json

Contributing Guidelines

Since the javascript-gameshow project doesn’t have an official contributing guide, we recommend following these best practices:

  1. Fork the repository: Fork the javascript-gameshow repository on GitHub to create a copy of the project under your account.
  2. Create a new branch: Create a new branch for your feature or bug fix using git checkout -b <branch-name>.
  3. Make your changes: Make your changes in the new branch.
  4. Test your changes: Ensure your changes pass all the tests using npm run test.
  5. Commit your changes: Commit your changes using git add . and git commit -m "Your commit message".
  6. Push your changes: Push your changes to your forked repository using git push origin <branch-name>.
  7. Create a pull request: Create a pull request from your forked repository to the original javascript-gameshow repository.

Continuous Integration and Deployment

The javascript-gameshow project uses Firebase for hosting and continuous integration. The following CI/CD configurations are in place:

  • Build: The project is built using npm run build when you deploy it to Firebase hosting.
  • Test: The project is tested using Jest and Enzyme when you run npm run test.
  • Deploy: The project is deployed to Firebase hosting using npm run deploy.

Additional Resources

For more information on the Preact CLI, refer to the CLI Readme. For more information on the Firebase documentation, refer to the Firebase documentation.

Happy contributing!