unkey.dev to solve API authentication and authorization with DX in mind. It's also 100% open source!Sadly I don't have the time to maintain this project. I'm building
Open Source Event Monitoring
Thank you for considering contributing to our open source project! We appreciate your interest and are excited to have you on board. This document outlines the steps you need to follow to contribute to the project effectively. Please read the guidelines carefully and feel free to reach out if you have any questions.
Before getting started, please ensure that you have the following third-party services set up:
- planetscale: Database
- tinybird: Time series database
- upstash: Optional, only required for reports
- clerk: Authentication
To install the project and its dependencies, follow these steps:
Ensure you have
pnpminstalled on your system. If not, you can install it by running:
npm install -g pnpm
Run the following command to install the project dependencies:
After setting up the required services, you need to set the corresponding environment variables in the
/apps/web/.env file. To do this, follow these steps:
- Make a copy of the
cp apps/web/.env.example apps/web/.env
- Open the
/apps/web/.envfile in a text editor and populate the values for the services mentioned above.
To prepare the Prisma database, follow these steps:
- Navigate to the
- Run the following command to push the database schema and generate Prisma Client:
npx prisma db push
To prepare the Tinybird database, follow these steps:
- Download the Tinybird CLI from here and install it on your system.
- After authenticating with the Tinybird CLI, navigate to the
- Push the necessary datasources using the following command:
tb push datasources/ tb push
Note: If the CLERK_WEBHOOK_SECRET env variable is not set, pass an empty string, and make sure to visit
/onboarding after signing up.
To build the project, execute the following command:
To run the project locally, use the following command:
pnpm turbo run dev --filter=web