Setup local development environment

This document describes how to setup the project on your local environment

Requirements

Composer 2

https://getcomposer.org/download/

Symfony server

https://symfony.com/doc/current/setup/symfony_server.html

OpenAI account

https://platform.openai.com/docs/introduction

Components versions

PHP 8.1

https://www.php.net/releases/8.1/en.php

Symfony 6.3

https://symfony.com/doc/6.3/index.html

Installation

Environment variables

At the root of the project, create a ".env.local" file from the ".env" file and fill in the variables:

• OPENAI_API_KEY (from your OpenAI account)
• OPENAI_ORGANISATION (from your OpenAI account)
• DATA_USER_JSON_FILE (ex: data/users_local.json)
• DATA_API_TOKEN_JSON_FILE (ex: data/api_tokens_local.json)

Install packages

composer install

Execute commands

Create a user

php .\bin\console user add --username=test --password=test --firstname=John --lastname=Doe --description="Test user" --roles="ROLE_APP,ROLE_API"

Create an API token

php .\bin\console api-token create --username=test

Start the server

Start the symfony server

symfony server:start

Next steps

Improvements

• Speech to text feature
• Chat feature
• Translation for other languages

Ideas

• Dockerize the project
• Add an external database
• Drupalize the project in order to get benefit of the security layer