Skip to content

Commit

Permalink
Update README.md with evagram instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonzhu09 authored Jun 28, 2024
1 parent 2d6ef7f commit 5df3bec
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
# evagram

## Getting Started

To get started with running the Evagram application in development mode, clone the JCSDA-internal/evagram repository into your local machine.

### Prerequisites

The Evagram application is a full-stack application comprised of the frontend, backend, and database services that will run and be built inside Docker containers, requiring the installation of Docker into the host system. Please refer to the Docker installation guide for installing Docker onto your OS system.

## Usage

Once Docker is successfully installed into your system, simply open the Docker CLI and type in this command: `docker compose up`. This will automatically build the Evagram application using the docker compose configuration file and click on https://localhost:3000 once the process has started.

0 comments on commit 5df3bec

Please sign in to comment.