To get started with the project, follow the steps below:
- NPM
- Clone the repository to your local machine.
- Navigate to the project directory:
cd project-directory
. - Install the dependencies by running
npm install
.
- In the root of the project directory, locate the file named
.env.template
. - Run the command
cp .env.template .env
to create a new.env
file with the same contents. - Edit the
.env
file according to your specific needs.
npm run dev
-
Build the docker image:
docker build \ --build-arg ARG_VITE_BACKEND_URL=<finesse-backend-url> \ -t finesse-frontend .
-
Run the image:
docker run -p 5000:3000 finesse-frontend
.Use arg
-e PORT=<port> -p 5000:<port>
if you wish to control the internal port.
You can also use docker-compose
to run the API with the client. The API is the
backend that this client uses and is available at
https://github.com/ai-cfia/finesse-backend.
To run the API and the client together, make sure you have all the environment variables required from the backend (see .env.template in the repository) and then you can use the following command:
docker-compose up --build
You can then access the client at http://localhost
.
npm test
npm run test:update
- Change the version in
package.json
- Run
npm run prestart