installation.md

Installation

Prerequisites

• Node.js version >=16.x
• Docker

Optional:

• Ngrok
• Terraform

Setup

1. Clone the repo

git clone https://github.com/specfy/specfy.git

2. Navigate to the project folder

cd specfy

3. Install the required packages using pnpm.

nvm use
npm install
npm install -g turbo

4. Create your .env files

cp .env.example .env

5. Open the root .env file:

code /.env

Feel free to update COOKIE_SECRET and PASSWORD_SALT. See Secrets section

6. Start Docker. This starts the required services like Postgres.

docker compose up -d

7. Migrate the database

turbo run db:migrate

8. Build

npm run build

9. Launch the API

npm run api

Go to http://localhost:3000

10. Launch the App

npm run app

Go to http://localhost:5173

11. Optional: Seed the Database

Caution

You need the API to be running to seed

turbo run db:seed

12. Optional: Launch the mail builder

npm run emails

Go to http://localhost:3001

14. ✅ Done.

Secrets

To run this project, locally or in production, you will need a few secrets.

Creating the GitHub App

You will need a GitHub app to allow oauth.

Configuration:

• Callback: https://api.specfy.io/0/auth/github/cb
• Identifying >Request user authorization (OAuth) during installation
• Post installation > Redirect on update
• Webhook > Active
  • Callback: https://api.specfy.io/0/github/webhooks

Permissions (read-only):

• Repository: Commit Statuses, Contents, Deployments, Environments, Metadata
• Org: Members
• Account: Email addresses

Subscribe to events:

• Meta, Member, Membership, Organization, Public, Push, Repository, Team, Team add

Others Secrets

• Resend key to send email
• Stripe key to allow billing
• Datadog key for metrics collection
• Open AI key for AI operations