Skip to content

docs: add backend getting started guide #52

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

Open
FREDPENTA5 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add backend getting started guide #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 33 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GreenCode

GreenCode is a full-stack system designed to support environmental, sustainability, and community-impact projects under Bos-Com.
It consists of a **Spring Boot backend API** and a **React frontend** (new addition), with future integrations planned.
It consists of a **Spring Boot backend API**. A React frontend integration is planned for a future release.

---

Expand All @@ -15,7 +15,7 @@ It consists of a **Spring Boot backend API** and a **React frontend** (new addit
- Dockerized for easy deployment
- Swagger/OpenAPI documentation

### Frontend (React)
### Frontend (React) (planned)
- Modern React (Create React App)
- React Router for navigation
- Axios for API communication
Expand All @@ -29,9 +29,39 @@ It consists of a **Spring Boot backend API** and a **React frontend** (new addit
GreenCode/
├── src/ # Spring Boot source code
├── config/ # external configuration & scripts
├── scripts/ # helper scripts
├── docs/ # architecture, API docs
├── greencode-frontend/ # React frontend (new)
├── pom.xml # Maven build file
└── docker-compose.yml # Docker orchestration

---
## 🚀 Getting Started (Backend)
### Prerequisites
- Java 17+
- Maven
- Docker (optional, if you want to run via `docker-compose.yml`)

### Configure environment variables
Copy the example environment file and adjust values as needed:
```bash
# Linux/macOS/Git Bash
cp env.example .env

# Windows PowerShell
Copy-Item env.example .env
```

### Run locally (no Docker)
```bash
mvn clean install
mvn spring-boot:run
```

### Run with Docker Compose (optional)
```bash
docker-compose up -d --build
```

Note: this repository’s `Dockerfile` expects a Maven wrapper (`mvnw`). If your clone does not include `mvnw`, run locally with Maven instead (see above) or update the `Dockerfile`.