-
Notifications
You must be signed in to change notification settings - Fork 15
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
krishna-dave206
wants to merge
1
commit into
apache:master
Choose a base branch
from
krishna-dave206:47
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
``` | ||
|
||
## 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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