https://github.com/p0u4a/paladin

Feature Flags as a Service
https://github.com/p0u4a/paladin

feature-flags feature-flags-management rest-api typescript

Last synced: 9 days ago
JSON representation

Feature Flags as a Service

• Host: GitHub
• URL: https://github.com/p0u4a/paladin
• Owner: P0u4a
• Created: 2023-12-25T03:56:59.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-05-02T09:01:53.000Z (8 months ago)
• Last Synced: 2024-05-02T22:10:24.397Z (8 months ago)
• Topics: feature-flags, feature-flags-management, rest-api, typescript
• Language: TypeScript
• Homepage: https://p0u4a-paladin.vercel.app
• Size: 412 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Paladin🛡️

Simple feature flag manager

## Motivation

An excercise to see how a minimally viable version of something like [LaunchDarkly](https://launchdarkly.com/) could be replicated.

## Usage

**Base URL**

`https://p0u4a-paladin.vercel.app/api`

**Endpoint**

`GET /external/get-flag?pname={projectName}&fname={flagName}`

**Headers** 

`X-Paladin-Key : `

**Response**

```ts

Flag = {

    name: string,

    description: string,

    active: boolean,

}

```

## Running Locally

1. Run `pnpm install`

2. Create a Vercel Postgres database on Vercel

3. Add the necessary enviornment variables to a `.env` file

   - `POSTGRES_URL`

   - `POSTGRES_PRISMA_URL`

   - `POSTGRES_URL_NON_POOLING`

   - `POSTGRES_USER`

   - `POSTGRES_HOST`

   - `POSTGRES_PASSWORD`

   - `POSTGRES_DATABASE`

   - `NEXTAUTH_SECRET`

4. Push schema to postgres with `prisma db push`

5. Use `pnpm run dev` to start project locally