Skip to main content

​
Get started in three steps

Set up your development environment, get familiar with the Clubedge workflow, and run your first project locally.

​
Step 1: Set up your local environment

Start by cloning the repository for the Clubedge project you’re working on.
Make sure you have access to the repository and are working from the correct branch before making changes.Check the project’s README.md for any project-specific setup requirements.
Install the dependencies using the package manager defined by the project.For Node.js projects, this will typically look like:
Copy the project’s environment template if one is provided:
Configure the required environment variables using the project’s development documentation.
Never commit .env files, credentials, API keys, or other secrets to the repository.

​
Step 2: Run the project locally

Follow the project’s development instructions to start the application locally.For many Clubedge services, this will be similar to:
Once the server is running, open the local URL provided by the project.
Check the project’s README.md and development documentation for the exact commands and required services.
Before making changes, verify that the project is working correctly.A typical setup check includes:
  1. Starting the application successfully.
  2. Running the project’s test suite.
  3. Checking that required services are available.
  4. Confirming that the application responds as expected.
For example:
The exact commands depend on the project you’re working on.

​
Step 3: Make your first change

Create a branch for your work instead of committing directly to the main branch.
Make your changes, then run the project’s checks before committing:
Commit your changes using the project’s commit conventions:
Push your branch and open a pull request for review.
Check the project’s contribution guidelines for its branch naming, commit, testing, and pull request requirements.

​
Next steps

Now that your local environment is ready, explore the resources relevant to your work:

Development

Learn about the Clubedge development workflow, project conventions, and contribution process.

Products & services

Explore the Clubedge products and services available to your application.

Integration

Learn how to integrate Clubedge services into your application.
Working on a specific Clubedge product? Start with its product documentation for project-specific setup, integration instructions, architecture, and API details.