Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.8 KB

INSTALLATION.md

File metadata and controls

36 lines (23 loc) · 1.8 KB

This file may be out of date as the installation method might be changing over time. Please open an issue on GitHub if you hit any problems

Installing VerifyWise

Currently, the recommended method of installing VerifyWise is via Docker. A development environment can also be set up via npm. Both options are described below.

Installing VerifyWise via Docker

In order to use VerifyWise via Docker, you will need a .env file and a docker-compose.yml file.

Docker setup

To set up VerifyWise in Docker, do the following:

  1. From the root of our GitHub repository, download .env, docker-compose.yml and SQL_Commands.sql.
  2. Move all the downloaded files to the directory where your VerifyWise container will be running. This directory will be referred to as your working directory from now on.
  3. Start your local Docker instance.
  4. In your working directory, open bash terminal.
  5. Run chmod +x ./install.sh followed by ./install.sh.

NOTE: The .env file is configured as per the default settings. Alternatively, you can supply your own .env file.

Developer Setup for VerifyWise via npm

Developers may prefer to run the VerifyWise server and client separately via npm.

To run VerifyWise's server and client via npm, follow these steps:

  1. Fork our GitHub repository.
  2. Clone your fork of the VerifyWise repository.
  3. From the root directory of the repository (./), go to ./Clients and run npm i; npm run dev. The VerifyWise client will start.
  4. From the root directory of the repository, go to ./Servers and run npm i; npm run watch. The VerifyWise server will start.

You can now access the VerifyWise frontend by navigating to https://localhost/5173 on a local web browser.