InsightsOut Prototype

Features

Tech Stack

Next.js (React)
Prisma (ORM)
PostgreSQL (Database)
OpenAI GPT4 + WHISPER (API)
TailwindCSS (Styling)
Turborepo (Monorepo)
ShadcnUI (Styling)
Sliplane.io (Hosting)

Development

To get started, you will need to have Node.js (v21) and pnpm (v8) installed. After cloning, run the following command:

pnpm install

You will then have to create an .env.local file in /apps/web/ and add the following:

DATABASE_URL=...
AUTH_SECRET=...
S3_URL=...
S3_USERNAME=...
S3_PASSWORD=...
S3_BUCKET=...

AUTH_SECRET can be any random string. If you are on a unix (macOS, Linux) system, you can run the following command to generate a random string:

openssl rand -base64 32

If you are on Windows, you can use the following command (untested)

node -e "console.log(require('crypto').randomBytes(32).toString('base64'))"

DATABASE_URL should be the URL to your PostgreSQL database. If you want to use the hosted database, please ping me (Jonas S.) on Slack

Then also create a .env file in /packages/database/prisma and copy the DATABASE_URL from the .env.local file.

Commands

A bunch of commands are available to you:

pnpm run dev --filter web # Start the web app
pnpm run dev db:push --filter database # Push the database schema to the database
pnpm run dev db:seed --filter database # Seed the database with some data
pnpm run dev db:generate --filter database # Generate the Prisma client

If you want to migrate the database schema, change your directory to packages/database and run npx prisma migrate dev. This will generate a new migration file in prisma/migrations and apply it to the database.

Deployment

The web app is deployed on sliplane.io using Docker. You can run the following command to build the Docker image:

docker build -t prototype -f ./apps/web/Dockerfile .

You can then run the following command to run the Docker image:

docker run -p 3000:3000 prototype

To deploy, simply push to the main branch. The app will be automatically deployed and available at https://insightsout.sliplane.app.

License

MIT License, see LICENSE

sdt-zeiss / prototype

readme