Herb Box ++

Initial setup

Install node dependencies:

npm install

Create .env file to setup environment variables:

cp .env.example .env

Add the values to the variables in the .env file, and they will be automatically loaded when the project is initialized.

Generate prisma client:

npm run prisma:generate

Initialize the db:

npx prisma migrate dev

Run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Environment Variables

The environment variables are automatically loaded when the project is initialized and when using the prisma commands.

Be careful not to add environment variables to the .env.example file, as it is being tracked by Git, and we don't want secrets to be accidentally leaked.

Name	Description
OPENAI_API_KEY	OpenAI platform API Key
DATABASE_URL_SQLite	SQLite db file path (Prisma)
SWAGGER_API_DOC_PATH	Swagger API documentation path

Simulate connection to the sensors

./scripts/simulateHistory.sh

Build and run with podman

This project mainly uses Podman to manage containers. We recommend to use Podman Desktop for a better development experience.

Run the following command to build the project using podman:

podman build -t herb-box-pp . 

Start the container:

podman run -p 3000:3000 localhost/herb-box-pp

Then open http://localhost:3000 or http://0.0.0.0:3000 to access the app web interface.