the Ironscholl

Ironschool/.gitattributes

@@ -0,0 +1,2 @@
+/mvnw text eol=lf
+*.cmd text eol=crlf

Ironschool/.gitignore

@@ -0,0 +1,15 @@
+# IntelliJ files
+.idea/
+*.iml
+out/
+
+# Java compiled files
+target/
+*.class
+
+# Log files
+*.log
+
+# OS files
+.DS_Store
+Thumbs.db

Ironschool/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,3 @@
+wrapperVersion=3.3.4
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.12/apache-maven-3.9.12-bin.zip

Ironschool/HELP.md

@@ -0,0 +1,28 @@
+# Getting Started
+
+### Reference Documentation
+
+For further reference, please consider the following sections:
+
+* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
+* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/4.0.3/maven-plugin)
+* [Create an OCI image](https://docs.spring.io/spring-boot/4.0.3/maven-plugin/build-image.html)
+* [Spring Boot DevTools](https://docs.spring.io/spring-boot/4.0.3/reference/using/devtools.html)
+* [Spring Web](https://docs.spring.io/spring-boot/4.0.3/reference/web/servlet.html)
+
+### Guides
+
+The following guides illustrate how to use some features concretely:
+
+* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
+* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
+* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)
+
+### Maven Parent overrides
+
+Due to Maven's design, elements are inherited from the parent POM to the project POM.
+While most of the inheritance is fine, it also inherits unwanted elements like `<license>` and `<developers>` from the
+parent.
+To prevent this, the project POM contains empty overrides for these elements.
+If you manually switch to a different parent and actually want the inheritance, you need to remove those overrides.
+

Ironschool/README.md

@@ -0,0 +1,37 @@
+# IronSchool Project 🚀
+
+hey guys! this is the repo for the ironschool project. me and the team built this for the java course. 
+its a spring boot api for managing our next big edtech startup (well right now just a MVP lol)
+
+## how to run / demo
+
+1. clone it 
+2. open in intellij or whatever u use
+3. run `IronschoolApplication.java`
+(or just do `./mvnw spring-boot:run` in terminal, kinda easier)
+
+we tested it with postman and it works on `localhost:8080` (mostly). 
+
+## the tech / how it works
+for the examiners/reviewers, here is what we actually built inside:
+
+**models we got:**
+- `Student`: holds student info
+- `Teacher`: holds teacher info & salary
+- `Course`: has the course details, price, and tracks how much `money_earned`
+
+**data storage:**
+tbh we didn't add a real database yet so it's all running on in-memory `HashMap`s inside the `SchoolService`. just run the app and hit the endpoints to test, but remember if you restart the app the data goes
+
+**what the API does:**
+we have a `SchoolController` that handles these GET endpoints:
+- `GET /students` -> spits out all students
+- `GET /courses` -> shows all courses and their stats
+- `GET /teachers` -> lists the teachers
+- `GET /profit` -> this is the big one for the startup! calculates `total revenue (from enrolled students) - total salaries (from teachers)`
+
+the `SchoolService` has the methods to `addStudent`, `addTeacher`, `addCourse`, `enrollStudent` (which automatically updates the course revenue!), and `assignTeacher`. 
+
+if something crashes during your review just try to restart it lol 
+
+✌️