Skip to content

Installation and maintenance

Henri Sjöblom edited this page Nov 12, 2024 · 2 revisions

Installation and running the app

Requirements:

  • VS Code or similiar text editor / IDE
  • Node.js / NPM
  • Supabase account
  • OpenAI API key

Development

First install the node_modules and run the application in development mode:

  1. npm i
  2. Setup .env.local values based on .env.example
  3. npm run dev
  4. The app will open in http://localhost:3000/

Production

First install the node_modules, then build the application and finally start it:

  1. npm i
  2. Setup .env.local values based on .env.example
  3. npm run build
  4. npm run start
  5. The app will open in http://localhost:3000/

Maintenance

App

To ensure security and the best performance, the app will need to be updated regularly. This can be done with the command npm audit fix, which attempts to upgrade automatically packages that have vulnerabilities. The current Next.js in the project is version 14, and the new 15 version shouldn't have any breaking changes.

There will likely be some issues in the future with the OpenAI library, since it's still in the early days

Server

We hosted our application on Vercel. Vercel takes care of all the maintenance, scaling, and performance optimization, so we don't have to worry about it.

Clone this wiki locally