Note

Sponsored by the Open Source project Flagsmith https://github.com/Flagsmith/flagsmith

HealthCheck

How friendly is your GitHub Open Source Repo? This project will check to make sure you are using Best Practices to attract more users, contributors and Stars, as well as suggest steps as to how you can improve the Repo to achieve this.

Quickstart guide

Caution

Node v21+ is required

1. Clone this GitHub Repo

2. Install the dependencies with npm ci

3. Copy .env.example to .env (you will need an environment key from Flagsmith, this is shown later on)

4. Create a free account on Flagsmith https://www.flagsmith.com (you can also sign in with GitHub)

5. Create an Organisation and Project

6. Create the Feature Flags with these steps

   a. Create the feature tagline by clicking Create Feature

   

   b. Fill in the Feature Flag form with these details and click Create Feature

   

   c. (OPTIONAL) Import the flags to your Flagsmith account using the file src/config/flagsmith.json (note this will be per environment, for example development)

   

7. Get your environment key from Flagsmith and add to .env file

8. To be able to log in using GitHub OAuth

   a. create a GitHub OAuth app on GitHub https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app

   b. In your GitHub OAuth app, GitHub will generate the client id and client secret, add these to your the .env file

9. Run the project with one of these

   a. Locally npm run dev

   b. Docker compose docker compose -f docker-compose.local.yaml up -d