Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docker local setup markdown [#47] #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,77 @@ Prerequisites: Docker engine is running

Run `docker-compose up setup` to initialize and `docker-compose up` to run.

# Apache Flagon - Local Setup Guide

## Introduction
Welcome to the **Apache Flagon** repository! This guide will help you set up the project locally for development and testing.

## Prerequisites
Ensure you have the following dependencies installed before proceeding:

- **Git**
- **Java (JDK 8 or later)**
- **Maven**
- **Node.js & npm** (for front-end development)
- **Python 3.x** (for analytics tools)
- **Docker** (if you plan to use development container services)

### Check Installed Versions
Run the following commands to verify your setup:

```bash
java -version
mvn -version
node -v
npm -v
python3 --version
docker --version
```

## Fork and Clone the Repository

```bash
git clone https://github.com/<username>/flagon.git
cd flagon
```

## Build the Project

```bash
mvn clean install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maven is not used by this project ,and this command will fail. There is no pom.xml

```

## Run the Application

```bash
mvn spring-boot:run
```

```Or Run the Application in Docker```

```bash
docker-compose up --build
```
## Access the Application

```http://localhost:8080```

## Contribution Setup
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you remove the contribution section? This information isn't specific to this folder and is adding noise.

- Create a new branch for your changes

```bash
git checkout -b feature/my-feature
```

- Commit your changes

```bash
git add .
git commit -m "Add my feature"
```

- Push your changes

```bash
git push origin feature/my-feature
```