Merge branch 'develop' of https://github.com/Real-Dev-Squad/skill-tre…

…e-backend into postEndorsementAPI

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI Build
+
+on:
+  pull_request:
+    branches:
+      - "**"
+jobs:
+  build:
+    name: Maven Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Java 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'temurin'
+
+      - name: Build with Maven
+        run: mvn verify --file skill-tree/pom.xml

.gitignore

@@ -25,3 +25,5 @@ replay_pid*
 
 .idea/
 .vscode/
+
+*.env

README.md

@@ -1 +1,110 @@
-# skill-tree-backend
+
+# Skill Tree Backend
+
+## Steps to Run the Service Locally
+
+### Required Tools
+
+- [Maven](https://mvnrepository.com/)
+- Java
+- Integrated Development Environment (IDE) (Preferred - IntelliJ Community or Ultimate Edition)
+- Docker Desktop
+- MySQL Docker Image
+
+### Steps to Connect the Service to MySQL Running in Docker
+
+Refer to this [link](https://find10archived.medium.com/how-to-connect-a-mysql-docker-container-with-a-local-spring-boot-application-9366707dce0d) for detailed steps.
+
+1. Create a database user with full access for table creation, deletion, and modification (for development only in local MySQL).
+2. After creating the database user, enter the credentials in the Skill Tree Spring Boot application.
+3. Attempt to connect to the database using the URL "jdbc:mysql://${MYSQL_HOST:localhost}:3306/${DB_NAME}".
+4. Create a simple API to test the database connection and data retrieval. For example, create a `/test` route in `skill-tree/src/main/java/com/RDS/skilltree/User/UserController.java`.
+    ```java
+    package com.RDS.skilltree.User;
+
+    import org.springframework.web.bind.annotation.GetMapping;
+    import org.springframework.web.bind.annotation.RestController;
+
+    @RestController
+    public class UserController {
+        @GetMapping("/test")
+        public void test(){
+            System.out.println("test123");
+        }
+    }
+    ```
+
+### Steps to Generate a JWT Token (Similar to [Website Backend Repo](https://github.com/Real-Dev-Squad/website-backend/issues))
+
+1. If you've already generated the public and private keys during the website backend setup, you can proceed directly to step 5.
+2. Ensure the website-backend is running locally.
+3. Generate Public and Private keys using openssl with the following commands:
+   - `openssl genrsa -out ./private.key 4096`
+   - `openssl rsa -in private.key -pubout -outform PEM -out public.key`
+4. Obtain a user token (private and public key stored in `local.js` file).
+5. After calling `localhost:3000/auth/github/login`, the backend will generate the JWT token.
+6. Validate the token using [jwt.io](https://jwt.io/) by entering the public and private keys stored in the website backend.
+7. Use the public key in the Skill Tree repo to decrypt the JWT token passed for authentication.
+
+## Steps for Creating the Database
+
+1. `create database skilltree;`
+2. `show databases;`
+3. `create user 'testuser' identified by 'testpassword';` (Username: testuser, Password: testpassword)
+4. `grant all on skilltree.* to testuser;`
+
+## Steps for connecting mysql workbench to run mysql inside docker
+
+1. `docker exec -it rds-db-1 bin/bash`
+2. bash-4.4# `mysql -u root -p -A`
+
+By default after deployment MySQL has following connection restrictions:
+```
+mysql> select host, user from mysql.user;
++-----------+---------------+
+| host      | user          |
++-----------+---------------+
+| localhost | healthchecker |
+| localhost | mysql.session |
+| localhost | mysql.sys     |
+| localhost | root          |
++-----------+---------------+
+4 rows in set (0.00 sec)
+```
+Apparently, for security purposes, you will not be able to connect to it from outside of the docker container. If you need to change that to allow root to connect from any host (say, for development purposes), do the following:
+
+3. update mysql.user set host='%' where user='root';
+4. Quit the mysql client.
+5. Restart the docker container
+
+Now you can connect to the mysql running in the docker container, also to connect to it on the terminal type `mysql -utestuser -p -P3306 -h127.0.0.1`
+
+## Additional Configuration Steps
+
+1. Download the EnvFile plugin from the marketplace.
+2. Create a new Env file with the provided content and fill in the RDS public key value.
+   ```env
+   DB_NAME=${DB_NAME}
+   MYSQL_USERNAME=testuser
+   MYSQL_PASSWORD=testpassword
+   DB_DDL_POLICY=update
+   RDS_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----
+                   xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+                   -----END PUBLIC KEY-----"
+   ```
+   Note : Publickey in both backend and skilltree backend should be the same.
+3. Click "Edit Configurations" -> Create a new application.
+4. Give it a name instead of "Unnamed".
+5. In "Build and Run", select Java 17.
+6. In the class , check "Enable Env file" and "Substitute env var" checkboxes.
+7. Click "Apply" and "OK".
+8. Click "Build and Run".
+9. Retrieve the Bearer token by accessing `http://localhost:3000/auth/github/login` and locating the key `rds-session-development` in the application. The value associated with this key is the `Bearer token`.
+10. Click the green "Run" button or "Shift + F10" to start the application
+11. After starting the Tomcat server on port `8080`, attempt to access the dummy route `http://localhost:8080/test` using the `GET` method in Postman or ThunderClient while providing the `bearer token`. If the terminal displays `test123`, it indicates that the setup has been successful.
+
+## Known Issues Faced by Other Developers
+1. Port 8080 Conflict: Make sure there is no other process running on the 8080 port where we are going to run our server check this with lsof -p PID (PID - port id)
+2. Local MySQL Conflict: Make sure there is no local Mysql running on the local machine
+
+---

api-contracts.yml

@@ -94,13 +94,13 @@ paths:
 
 
 
-  /skills/{skillName}:
+  /skills/name/{name}:
     get:
       tags: 
         - skills
       parameters:
         - in: path
-          name: skillName
+          name: name
           required: true
           schema: 
             type: string