Edit

Collabocate [Plugin]

SOFTWARE ENGINEERING CONTRIBUTING DOC FOR COLLABOCATE PLUGIN

General Information about project

Collabocate [Plugin]COLLABOCATE PLUGIN PROJECT

Local development instructions

We've made recent changes to the repository location and local development instructions of this project. Therefore, this section may be outdated. For now and pending the time that this section will be updated, you can get guidance on where to find and how to run this project in our collabo community Discord channel.

Find the local development instructions for the different Collabocate projects in the tabs below, depending on the one you want to develop locally.

Once you have the repository on your local computer, ensure you are in the root of the project's directory. Then install and run following the steps below.

Install project dependencies

Install dependencies:

npm install

First time setup instructions for GitHubSync [General]

Make a copy of the .env.example file, then rename the copy to .env - it is this renamed copy that you will store your secrets in. Ensure that the .env file is in the root of the project's directory.

First time setup instructions for GitHubSync [API server]

Do not litter our repositories with your GitHubSync tests or experiments. Use the REPO_API_URL for the community's test/experiment repo has shown below.

Request for the GITHUB_PERSONAL_ACCESS_TOKEN that works with our repos, from our community Discord server.

In the .env file, supply:

  • The (GitHub) REPO API url of the repository the community's test/experiment repo in the .env file as shown below (i.e. just copy and paste this in your .env file). Make sure to add it under/after the GITHUB_API_BASE_URL environment variable so that the variable in the repo url can take effect:

REPO_API_URL=${GITHUB_API_BASE_URL}/repos/collabo-community/use-me-for-experiments

  • The GitHub personal access token for accessing the repo url:

GITHUB_PERSONAL_ACCESS_TOKEN=add-the-token-here

  • The port number of your choice (for the API server to run on) e.g.

PORT=4800

First time setup instructions for GitHubSync [test client]

In the .env file, supply:

  • The backend url as shown below (i.e. just copy and paste this in your .env file). This is what will help connect the client to the API server. Make sure to add it under/after the PORT environment variable so that the variable in the backend url can take effect:

BACKEND_URL=http://localhost:${PORT}

  • The port number of your choice (for the test client to run on) e.g.

CLIENT_APP_PORT=5500

Running the API server

Start the API server. In the root of the repository, run this in your terminal:

npm run dev:api

Running the test client

Start the client. In the root of the repository, run this in your terminal:

npm run dev:client
PreviousContribution Workflow for EngineersNextCollabocate [Website]

Last updated

Was this helpful?