Skip to content

docs: add getting started and setup instructions (#56). #74

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
Its-Hannah wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add getting started and setup instructions (#56). #74

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
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,21 @@ GreenCode/
├── greencode-frontend/ # React frontend (new)
├── pom.xml # Maven build file
└── docker-compose.yml # Docker orchestration

Issue #56
### 1. Prerequisites
- *Java:* Version 17 or higher.
- *Node.js:* For the React frontend.
- *Database:* PostgreSQL installed and running.
- *Build Tool:* Maven.

### 2. Backend Setup
1. Navigate to the root directory.
2. Configure your database details in the env.example file and rename it to .env.
3. Run mvn install to download dependencies.
4. Run mvn spring-boot:run to start the backend.

### 3. Frontend Setup
1. Navigate to the greencode-frontend directory.
2. Run npm install.
3. Run npm start to launch the UI.