Envision Portal

Getting started

Prerequisites/Dependencies

You will need the following installed on your system:

• Node.js
• Yarn
• Docker
• Volta (optional)

Setup

1. Clone the repository

   git clone https://github.com/eyeact/envision-portal.git

2. Install the dependencies

   yarn install

3. Add your environment variables. An example is provided at .env.example

   cp .env.example .env

4. Start the development server

   yarn dev

5. Open the application in your browser

   open http://localhost:3000

Development

Database

The application uses a PostgreSQL database for storing data. You can use Docker to run these services locally.

docker-compose -f ./dev-docker-compose.yaml up
docker-compose -f ./dev-docker-compose.yaml up -d # if you want the db to run in the background

Close the database with:

docker-compose -f ./dev-docker-compose.yaml down

Prisma

The application uses Prisma to interact with the database.

UI

The application uses Nuxt UI to build the UI components. It also uses Tailwind CSS for styling.