Development

🛠️ Scenario Launch Platform - Development Guide

Welcome to the Scenario Launch Platform development guide! 🚀

This document provides details on setting up your environment, required tools, and best practices for contributing to the project.

---

🔧 Tools Required

Before you begin, ensure you have the following tools installed:

Tool	Version	Download Link
Eclipse IDE	Latest	🔗 Eclipse
PostgreSQL	14+	🔗 PostgreSQL
Apache Maven	3.9+	🔗 Maven
Git	Latest	🔗 Git
Java JDK	17+	🔗 OpenJDK

---

⚙️ Setting Up the Development Environment

1️⃣ Clone the CyberSkill repository

git clone https://github.com/IBM/CyberSkill.git

2️⃣ Configure PostgreSQL Database

• 🔑 Connect to your Postgresql database and create a new database called slp.
• 🏃‍♂️ Run the SQL file in the newly created database. This will create the tables and insert the data for SLP.

Example SQL to create the SLP DB on linux:

sudo -u postgres psql 
CREATE DATABASE slp;
\c slp
\i /tmp/tables.sql;
\q

3️⃣ Import the Project into Eclipse

Open Eclipse → File → Import → Git → Projects from Git → Next → Exisitng local respository → Next → Add → Browse to repo → Select repo → Add → Import repo . Select the ScenarioLaunchPlatform folder.

4️⃣ Compile the project

mvn clean compile vertx:run

5️⃣ Build the project

mvn clean package

📜 Development Guidelines

To maintain code quality, follow these guidelines:

✔️ Follow Java coding standards - Use meaningful variable names and proper indentation.
✔️ Keep commits atomic - Each commit should focus on a single task or fix.
✔️ Write unit tests - All new features should include tests were possible.
✔️ Use feature branches - Create branches for new features (feature/use-case-X).
✔️ Follow PR guidelines - Provide clear descriptions in pull requests.
✔️ Run tests before pushing - Ensure all tests pass before submitting a PR.