Skip to content

Commit

Permalink
fix: easier dev setup
Browse files Browse the repository at this point in the history
  • Loading branch information
ephraimduncan committed May 26, 2024
1 parent d7f9bf7 commit 0ba1bbf
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 31 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,16 @@ Formbase is an open-source form backend for handling forms, notifications, secur

## Tech Stack

- [Next.js](https://nextjs.org/) – framework
- [TypeScript](https://www.typescriptlang.org/) – language
- [Tailwind](https://tailwindcss.com/) – CSS
- [PostgresSQL](https://postgresql.org/) – database
- [Lucia Auth](https://lucia-auth.com/) – auth
- [Next.js](https://nextjs.org/) – Franework
- [TypeScript](https://www.typescriptlang.org/) – Language
- [Tailwind](https://tailwindcss.com/) – Styling
- [PostgresSQL](https://postgresql.org/) – Database
- [Lucia Auth](https://lucia-auth.com/) – Authentication
- [Turborepo](https://turbo.build) - Monorepo

## Contributing

Here's how you can contribute:

- [Open an issue](https://github.com/eight-labs/formbase/issues) if you believe you've encountered a bug.
- Make a [pull request](https://github.com/eight-labs/formbase/pull) to add new features/make quality-of-life improvements/fix bugs.

## Repo Activity

![formabase.dev repo activity – generated by Axiom](https://repobeats.axiom.co/api/embed/007fbbe6f439184bf7a20b76f7f9dff7e5139330.svg 'Repobeats analytics image')
15 changes: 7 additions & 8 deletions apps/web/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,17 @@
# Drizzle
# Get the Database URL from the "prisma" dropdown selector in PlanetScale.
# Change the query params at the end of the URL to "?ssl={"rejectUnauthorized":true}"
DATABASE_URL='mysql://YOUR_MYSQL_URL_HERE?ssl={"rejectUnauthorized":true}'
SMTP_HOST='smtp.example-host.com'
SMTP_PORT=25
SMTP_USER='smtp_example_username'
SMTP_PASSWORD='smtp_example_password'
DATABASE_URL='postgresql://formbase:[email protected]:5432/formbase'
SMTP_HOST=127.0.0.1
SMTP_PORT=2500
SMTP_USER="formbase"
SMTP_PASSWORD="formbase"
NEXT_PUBLIC_APP_URL='http://localhost:3000'

# The callback URL for githubs Oauth is localhost:3000/login/github/callback
# Obviously replace localhost and port of you are using this in a production environment.

GITHUB_CLIENT_ID='GITHUB_client_id'
GITHUB_CLIENT_SECRET='GITHUB_client_secret'
AUTH_GITHUB_ID="github_client_id"
AUTH_GITHUB_SECRET="github_client_secret"

# Formbase
ALLOW_SIGNIN_SIGNUP=true
Expand Down
14 changes: 6 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
{
"name": "formbase",
"version": "0.1.5",
"private": true,
"description": "A comprehensive, opinionated company monorepo boilerplate",
"author": "Eight Labs",
"version": "0.1.0",
"type": "module",
"scripts": {
"build": "turbo build",
"clean": "rimraf --glob **/node_modules **/dist **/.turbo **/.next **/.astro **/.eslintcache pnpm-lock.yaml **/.tsbuildinfo **/test-results",
"db:start": "docker-compose -p formbase -f ./docker/docker-compose.yml up -d",
"dev": "pnpm run db:start && turbo dev",
"format": "pnpm format:write",
"d": "pnpm install && pnpm docker:start && pnpm run dev",
"dev": "turbo dev",
"docker:start": "docker-compose -p formbase -f ./docker/docker-compose.yml up -d",
"format": "prettier \"**/*\" --ignore-unknown --list-different --write",
"format:check": "prettier \"**/*\" --ignore-unknown --list-different",
"format:write": "prettier \"**/*\" --ignore-unknown --list-different --write",
"lint": "eslint . --cache --max-warnings 0",
"reset:changelog": "rimraf --glob **/*.mdx",
"typecheck": "tsc --noEmit --tsBuildInfoFile .tsbuildinfo"
Expand Down
3 changes: 0 additions & 3 deletions packages/env/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ export const env = createEnv({
AUTH_GITHUB_ID: z.string().optional(),
AUTH_GITHUB_SECRET: z.string().optional(),

GITHUB_CLIENT_ID: z.string().trim().min(1),
GITHUB_CLIENT_SECRET: z.string().trim().min(1),

SMTP_HOST: z.string().trim().min(1),
SMTP_PORT: z.coerce.number().int().min(1),
SMTP_USER: z.string().trim().min(1),
Expand Down
18 changes: 15 additions & 3 deletions turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,21 @@
"DATABASE_URL",
"AUTH_GITHUB_ID",
"AUTH_GITHUB_SECRET",
"AUTH_GOOGLE_ID",
"AUTH_GOOGLE_SECRET",
"AUTH_GOOGLE_CODE_VERIFIER"
"SMTP_HOST",
"SMTP_PORT",
"SMTP_USER",
"SMTP_PASSWORD",
"STRIPE_API_KEY",
"STRIPE_WEBHOOK_SECRET",
"STRIPE_PRO_MONTHLY_PLAN_ID",
"ALLOW_SIGNIN_SIGNUP",
"UMAMI_TRACKING_ID",
"MINIO_ENDPOINT",
"MINIO_PORT",
"MINIO_USESSL",
"MINIO_ACCESSKEY",
"MINIO_SECRETKEY",
"MINIO_BUCKET"
],
"outputs": [".next/**", "!.next/cache/**", "dist/**"]
},
Expand Down

0 comments on commit 0ba1bbf

Please sign in to comment.