getting-started.md

1. Getting started

This guide will help you to set up the project in a production environment. This guide assumes that you have already installed conda, Java 11 and Bun (or another runtime environments) in your system.

1.1. Create project Python environment

conda env create -f environment.yml

1.2. Activate environment

conda activate beer-search-engine

1.3. Install frontend dependencies

The project has been developed using Bun as a package manager and runtime environment. If you don't have it installed, please follow the installation guide. Otherwise, if you prefer to use another package manager, you can use npm, yarn or pnpm.

cd frontend && bun install

or

cd frontend && npm install

or

cd frontend && yarn install

or

cd frontend && pnpm install

1.4. Start backend

cd backend && make start

1.5. Start frontend

cd frontend && make start

1.6. Open browser

The application will be available at http://localhost:3000.