INSTALLATION.md

Installation

• Installation
  • Pre-requisites
    • Docker
    • Pre-commit
  • Installation steps
  • Additional steps

Pre-requisites

Docker

Download docker for your operating system: https://docs.docker.com/get-docker/

Pre-commit

1. Install pre-commit Use pip to install pre-commit

   pip install pre-commit

   Or using homebrew on macOS

   brew install pre-commit

   For more installation alternatives, check out Pre-commit official documentation.

2. Verify pre-commit installation

   pre-commit --version

Installation steps

Follow the steps below to set up the repo for development

1. Clone the repository and change the working directory

   git clone https://github.com/avantifellows/plio-frontend.git
   cd plio-frontend

2. For DEVELOPMENT PURPOSE only, make sure Docker Desktop application is running and docker version is giving a proper output.

   docker --version

3. Set up your .env file by copying .env.example file

   cp .env.example .env

4. Update environment variables in your .env file based on your environment. For all available settings, see our Environment variables guide.

5. Build the docker image and run the containers using just one command:

   npm install
   docker-compose up -d --build --renew-anon-volumes

6. For development only, run the following command to install pre-commit

   pre-commit install

7. Your frontend app should be accessible at http://localhost:8080.

   NOTE - To install and set up the Plio Backend, follow the steps outlined here.

Additional steps

1. To enable Google sign-in support, visit the Google OAuth2 guide.