Skip to content

4252 - updated documentation and .gitignore #4321

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.

Sign up for GitHub

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

Merged
ivicac merged 2 commits into from
Mar 4, 2026
Merged

4252 - updated documentation and .gitignore #4321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c26d8fb
4252 - updated .gitignore
marko-kriskovic Feb 26, 2026
68c323e
4252 - updated the documentation
marko-kriskovic Feb 26, 2026
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
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,4 +177,4 @@ rebel.xml
# Docker
######################
**/local.env
*.env
**/.env
24 changes: 20 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,12 @@ Pull requests are the best way to propose changes to the codebase (we use [Git-F
### Server Side

3. **Change working directory to the `BYTECHEF_HOME/server` folder.**
4. Create a .env file in the `BYTECHEF_HOME/server` directory.
5. Paste the following content into the .env file:

```bash
PASSWORD_FROM_LOCAL_DOT_ENV_FILE=postgres
```
4. Start up the docker container with dependent infrastructure

```bash
Expand Down Expand Up @@ -143,10 +149,20 @@ Pull requests are the best way to propose changes to the codebase (we use [Git-F

Build and run the server codebase in a Docker container. This is the easiest way to get the server instance up and running if you are more interested in contributing to the [client codebase](#client-side).

```bash
docker compose -f docker-compose.dev.server.yml down --rmi local
docker compose -f docker-compose.dev.server.yml up -d
```
3. **Change working directory to the `BYTECHEF_HOME/server` folder.**
4. Create a .env file in the `BYTECHEF_HOME/server` directory.
5. Paste the following content into the .env file:

```bash
PASSWORD_FROM_LOCAL_DOT_ENV_FILE=postgres
```
4. Start up the docker container with dependent infrastructure

```bash
docker compose -f docker-compose.dev.server.yml down --rmi local
docker compose -f docker-compose.dev.server.yml up -d
```
5. Make sure `java -version` and `JAVA_HOME` references Java JDK 25+

### Client Side

Expand Down