Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonzhu09 committed Jul 4, 2024
1 parent 8b9f2ae commit 85e302c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

## Getting Started

To get started with running the Evagram application in development mode, clone the JCSDA-internal/evagram repository into your local machine.
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.
Once Docker is successfully installed into your system, simply open the Docker CLI to build and run the application: `docker compose build` and `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 85e302c

Please sign in to comment.