Skip to content

Latest commit

 

History

History
204 lines (131 loc) · 9.6 KB

CONTRIBUTING.md

File metadata and controls

204 lines (131 loc) · 9.6 KB
Raw

Contributing to Unleash

Getting started

Before you begin:

  • Have you read the code of conduct?
  • Check out the existing issues
  • Browse the developer-guide for tips on environment setup, running the tests, and running Unleash from source.
  • You need
    • Node 20
    • corepack enabled corepack enable

Don't see your issue? Open one

If you spot something new, open an issue. We'll use the issue to have a conversation about the problem you want to fix. If we need more information in order to look into issue we'll respond on the issue and also and mark the issue as more-information-needed. Please note that we have an active bot monitoring our open issues that will close issues marked as more-information-needed if we haven't received a response within 14 days. If this happens, please don't hesitate to reopen the issue with more information.

Ready to make a change? Fork the repo

Fork using GitHub Desktop:

Fork using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

Fork with GitHub Codespaces:

Build and run the project

Follow the steps in the "how to run the project" section to get the project running locally.

Make your update:

Make your changes to the file(s) you'd like to update. You'll need Node.js v18 and PostgreSQL 14 to run Unleash locally. See more details

Open a pull request

When you're done making changes and you'd like to propose them for review by opening a pull request.

Submit your PR & get it reviewed

  • Once you submit your PR, others from the Unleash community will review it with you. The first thing you're going to want to do is a self review.
  • After that, we may have questions, check back on your PR to keep up with the conversation.
  • Did you have an issue, like a merge conflict? Check out GitHub's git tutorial on how to resolve merge conflicts and other issues.
  • We do have bots monitoring our open PRs, which will mark PRs as stale if they haven't had any activity within 30 days and close stale issues without activity after another 7 days. If you feel this was in error, please reach out to us or reopen the issue with more information.

Your PR is merged!

Congratulations! The whole Unleash community thanks you. ✨

Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.

How to run the project

Install the required prerequisites and then follow the steps below.

Prerequisites

You'll need:

  • Docker to run the database
  • Node.js to run the project. You can install it directly, or use nvm (see the next point) to manage it for you.
  • nvm (optional) to manage your Node.js installation.
  • Yarn (optional but recommended; the steps below assume that you have it installed) to install packages and run the project.

How to run Unleash with Node.js

  1. Use nvm to install the correct version of Node.js. From anywhere in the repo, run the below command. Skip this step if you're managing your Node.js installations yourself.

    nvm use

  2. Install packages:

    yarn

  3. Start a Postgres database for Unleash via Docker.

    • If this is the first time you're setting it up, run it using the below command. It will start the container with default connection details, call the container postgres, and expose it on port 5432.
    docker run \
    -e POSTGRES_USER=unleash_user \
    -e POSTGRES_PASSWORD=password \
    -e POSTGRES_DB=unleash \
    --name postgres \
    -p 5432:5432 \
    -d \
    postgres

    The connection details that Unleash will try to use are found in src/server-dev.ts. The above command works with the current defaults (at the time of writing).

    • If you've set up the database previously, you can restart the container by running this (assuming postgres is the name you gave the container):
    docker start postgres

  4. Start Unleash. Run the below command and Unleash will start up and try to connect to the database. On a successful connection it will also configure the database.

    yarn dev

  5. Log into the admin UI. Use a browser and navigate to localhost:3000. Log in using:

    • username: admin
    • password: unleash4all

How to run Unleash with Docker and Buildx

  1. Build a local docker image by running docker buildx build . -t unleash:local
  2. Create a network by running docker network create unleash
  3. Start a Postgres database. Make sure to use the network you created in step 2.
docker run -e POSTGRES_PASSWORD=password \
  -e POSTGRES_USER=unleash_user -e POSTGRES_DB=unleash \
  --network unleash --name postgres postgres
  1. Start Unleash. As with the database, use the network you created in step 2.
docker run -p 4242:4242 \
  -e DATABASE_HOST=postgres -e DATABASE_NAME=unleash \
  -e DATABASE_USERNAME=unleash_user -e DATABASE_PASSWORD=password \
  -e DATABASE_SSL=false \
  --network unleash unleash:local
  1. Log into the admin UI. Use a browser and navigate to localhost:4242. Log in using:
    • username: admin
    • password: unleash4all

Troubleshooting

Have any issues when getting set up?

Can't connect to the database

If you can't connect to the docker container, check its status by running docker ps. This command lists the currently running containers. Find the name of the container that you set up. If it's there, make sure that its port is mapped to your local machine: It should look like this: 0.0.0.0:5432->5432/tcp with the arrow (->) connector. If it just says 5432/tcp, it is not exposed to your local network.

To fix this, start a new container and make sure you give it the -p 5432:5432 option.

Running end-to-end (e2e) tests

To run the e2e tests, you'll need a running Postgres instance that you can connect to. The easiest way to set this up is to use Docker. This command starts a Postgres instance with the required configuration (according to the details in src/test/e2e/helpers/database-config.ts):

docker run --name unleash-postgres -p 5432:5432 -e POSTGRES_USER=unleash_user -e POSTGRES_PASSWORD=password -e POSTGRES_DB=unleash_test -d postgres:15

Unleash will attempt to connect using the connection string in src/test/e2e/helpers/database-config.ts or the environment variable TEST_DATABASE_URL.

Nice to know

Controllers

In order to handle HTTP requests we have an abstraction called Controller. If you want to introduce a new route handler for a specific path (and sub pats) you should implement a controller class which extends the base Controller. An example to follow is the routes/admin-api/feature.ts implementation.

The controller takes care of the following:

  • try/catch RequestHandler method
  • error handling with proper response code if they fail
  • await the RequestHandler method if it returns a promise (so you don't have to)
  • access control so that you can just list the required permission for a RequestHandler and the base Controller will make sure the user have these permissions.

Creating a release

In order to produce a release you will need to be a Unleash core team member and have the Unleash admin role assigned on the Unleash organization on GitHub.

Step 1: create a new version tag

Use npm to set the version in package.json and specify a version tag.

npm version 3.10.0

This command will trigger an internal verification step where we will perform the following steps:

  • STEP 1. Check unleash-frontend version - Validate that a latest release of unleash-server does not depend on a pre-release of unleash-frontend (beta, alpha, etc)
  • STEP 2. Lint - Run lint checks on the code.
  • STEP 3. Build - Validate that we are able to build the project
  • STEP 4. Test - Validate that all test runs green.

If all steps completes a single commit is produced on the main branch where the version property in package.json is updated, and a git tag is created to point to that tag specifically.

Step 2: push tag

git push origin main --follow-tags

This will push the new tag and a GitHub action will trigger on the new version tag, build the release and publish it to npm.