From 31f9f0dca0f57acbfed3649903a7b3e9d0cb4a3a Mon Sep 17 00:00:00 2001 From: zman Date: Thu, 30 Nov 2023 15:25:11 -0500 Subject: [PATCH] readme --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..139096e --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Getting Started + +To run this project, follow these simple steps: + +## Prerequisites + +- **Docker**: Make sure you have Docker installed on your system. You can download it from [here](https://www.docker.com/products/docker-desktop). + +## Step 1: Clone the Repository + +Clone this Git repository to your local machine: + +```bash +git clone https://gitea.zmanplex.com/zman27/garage_project.git +cd garage_project +``` + +## Step 2: Start the Docker Container + +First time/rebuild +```bash +docker-compose up --build +``` +Run in background +```bash +docker-compose up -d +``` + +## Step 3: Access The Application + +Once the container is running, you can access your application by opening a web browser and navigating to http://localhost. You should see the project running. + +## Stopping the container +To stop and remove the container, run: +```bash +docker-compose down +``` \ No newline at end of file