Merge branch 'code-differently:main' into Work26

Author: DavisD251

capstone/README.md

@@ -0,0 +1,116 @@
+# Capstone Project
+
+For the next two weeks, you and your team will ideate and implement a working software system. You will have the opportunity to apply the skills that you have learned to solve an interesting problem or contribute a meaningful tool that improves our lives.
+
+### Changelog
+- 4/24 @anthonydmays Published initial version
+
+### Technical Requirements
+
+Your project submission must include the following elements:
+
+* All work must be submitted in your team's assigned GitHub repository. Your team must track issues, bugs, pull requests, and features. See [Lesson 05][lesson-05] for a refresh.
+* Each team member must contribute *at least two* submitted pull requests containing working code and tests. See [Lesson 15][lesson-15] for a refresh.
+* Write unit tests achieving 80% code coverage (using JaCoCo for Java or Jest for Typescript).
+* Must have a working front-end that interacts with a back-end web service to retrieve and persist data.
+* Your app must be publicly accessible. It is recommended that you use [Vercel](https://vercel.com) or [Fly.io](https://fly.io) to deploy your apps.
+* The system must incorporate one third-party API.
+* Your repo must include a README with the following elements:
+    * The team
+    * Screenshot
+    * A description of the app
+    * Demo link
+    * Installation instructions
+    * Known issues
+    * Roadmap features
+    * Credits
+* It is **HIGHLY** recommended that you maintain a clean `Main` branch and only merge changes via pull requests (we've been using squashed merges for the main repo to simplify commit history). Don't forget to use [Conventional Commits][conventional-commits-link].
+
+### Important Milestones
+
+To ensure the timely completion of your project, you will need to complete the following milestone tasks.
+
+<table>
+    <thead>
+        <th>Milestone</th>
+        <th>Date</th>
+    </thead>
+    <tbody>
+        <tr>
+            <td>Submit user stories to your repo as GitHub issues</td>
+            <td>Thurs, May 8</td>
+        </tr>
+        <tr>
+            <td>
+                Obtain project sign-off from instructor/TAs<br>
+                <a href="https://calendar.google.com/calendar/u/0/appointments/schedules/AcZssZ1dD0ruj64FcykMfPBo7qQaV6AqZ58O7ON8Z3ld-xwNEbFmy0JGyLuwIwxJZjoGoEuz1U9bRZqu">
+                    Schedule a review meeting here
+                </a>
+            </td>
+            <td>Fri, May 9</td>
+        </tr>
+        <tr>
+            <td>Hold Sprint planning meeting</td>
+            <td>Mon, May 12</td>
+        </tr>
+        <tr>
+            <td>Begin implementing your designs</td>
+            <td>Mon, May 12</td>
+        </tr>
+        <tr>
+            <td>Update your meeting notes document</td>
+            <td>Daily</td>
+        </tr>
+        <tr>
+            <td>
+                Practice presentation sessions
+            </td>
+            <td>Wed-Thurs, May 21-22</td>
+        </tr>
+        <tr>
+            <td>Presentations due</td>
+            <td>Thurs, May 22, EOD</td>
+        </tr>
+        <tr>
+            <td>Final presentations</td>
+            <td>Fri, May 23</td>
+        </tr>
+    </tbody>
+</table>
+
+### Helpful Resources
+
+Here are some links to tools and templates that can help you work together effectively.
+
+* [TODO App (fullstack NextJS app in TypeScript)](/lib/javascript/fullstack_demo)
+* [TODO App (fullstack React + Java Spring app in TypeScript/Java)](/lib/java/fullstack_demo)
+* [v0 (chatbot for generating UI and web applications)](https://v0.dev)
+* [A Short Guide to Effective Daily Standups (Nave)](https://getnave.com/blog/short-guide-daily-standups/)
+* [Team Meeting Notes template (Google Docs)](https://docs.google.com/document/d/1rL-Zm2w0hABuGkIMSPzmXcJHDQxmIeA-mlipt8kDA9E/edit)
+* [Crafting Effective User Stories: A Guide to Good and Bad Versions (Visual Paradigm)](https://guides.visual-paradigm.com/crafting-effective-user-stories-a-guide-to-good-and-bad-versions/)
+* [Third-party APIs (MDN)](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Client-side_web_APIs/Third_party_APIs)
+* [GitHub Flow (GitHub.com)](https://docs.github.com/en/get-started/using-github/github-flow)
+* The Software Engineer's Guidebook, Chapter 10, "Tools of the Productive Software Engineer."
+
+### Presentation Guidelines
+
+For your presentation, you will be given up to 20 minutes to feature your project. Each person on the team should have a speaking role. Here's what your presentation will contain:
+
+1. Up to four slides of content, then a live demo walkthrough.
+2. Your presentation should cover the following items, in order:
+   - [ ]  Introduce team members and their roles
+   - [ ]  State the problem your attempting to solve
+   - [ ]  State how your app is designed to solve the problem
+   - [ ]  Show your demo
+   - [ ]  Discuss how you'd like to enhance in the future
+   - [ ]  Lastly, talk through technical challenges and features.
+3. You will be given 5 minutes for Q&A and take questions from the audience.
+
+### Academic Integrity
+
+Please refer to the [Academic Integrity][academic-integrity-link] section of the syllabus regarding the use of third-party code and resources that you have used for your project. Give credit to where credit is due!
+
+[conventional-commits-link]: https://www.conventionalcommits.org/en/v1.0.0/
+[academic-integrity-link]: /syllabus/README.md#academic-integrity
+[lesson-05]: /lesson_05/README.md
+[lesson-15]: /lesson_15/README.md

lesson_26/api/java/api_app/build.gradle.kts

@@ -5,7 +5,6 @@ plugins {
     id("com.diffplug.spotless") version "6.25.0"
 	  id("org.springframework.boot") version "3.4.0"
     id("com.adarshr.test-logger") version "4.0.0"
-    id("io.freefair.lombok") version "8.6"
 }
 
 apply(plugin = "io.spring.dependency-management")
@@ -39,6 +38,10 @@ dependencies {
     implementation("org.apache.commons:commons-csv:1.10.0")
     implementation("org.xerial:sqlite-jdbc:3.36.0")
     implementation("org.hibernate.orm:hibernate-community-dialects:6.2.7.Final") 
+    compileOnly("org.projectlombok:lombok:1.18.38")
+    annotationProcessor("org.projectlombok:lombok:1.18.38")
+    testCompileOnly("org.projectlombok:lombok:1.18.38")
+    testAnnotationProcessor("org.projectlombok:lombok:1.18.38")
 }
 
 application {
@@ -76,4 +79,4 @@ configure<com.diffplug.gradle.spotless.SpotlessExtension> {
     // fix formatting of type annotations
     formatAnnotations()
   }
-}
+}

lesson_27/README.md

@@ -13,4 +13,28 @@ Please review the following resources before lecture:
 
 ## Homework
 
-- TODO(anthonydmays): Provide some details here
+- [ ] Complete the [Using an API](#using-an-api) assignment.
+- [ ] Do pre-work for [lesson 28](/lesson_28/).
+
+### Using an API
+This exercise will give you hands-on experience with the React framework and supporting tools to enhance a dynamic front-end application that communicates with a backend API.
+
+#### Starting the servers
+
+1. Copy the React [template](./template/) folder to your own unique folder. Make necessary code changes in your folder only. 
+2. Install the [API server](./api/) using `npm install` and then run it using the `npm run dev` command. 
+3. Install the React web server in your copy using `npm install` and then run it using the `npm run dev` command.
+
+#### Updating the ProgramList components
+4. Modify the `ProgramList` component so that it calls the API to generate a list of programs using the returned data instead of the fake data. The needed HTML and CSS has already been provided for you.
+  - You can reference the types/interfaces used in the API by importing from the `@code-differently/types` package. 
+
+#### Create a page for adding new programs
+4. Create a new page (similar to the Home page component) that allows you to provide a new title and description and then use the API to add it to the existing list of programs.
+5. Add a link to the new page in the [Header](./template/src/components/header/Header.tsx) component that navigates to the new page.
+
+> [!NOTE]
+> You can use the [React Router tutorial](https://reactrouter.com/en/main/start/tutorial#updating-contacts-with-formdata) to learn how to handle form submissions. You can also use the [React Query guide](https://tanstack.com/query/latest/docs/framework/react/guides/mutations) to learn how leverage mutation to post to an API. 
+
+[react-query-link]: https://tanstack.com/query/latest/docs/framework/react/quick-start
+[react-router-link]: https://reactrouter.com/en/main/start/tutorial

lesson_27/api/.prettierrc

@@ -0,0 +1,24 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "arrowParens": "avoid",
+  "importOrder": [
+    "<THIRD_PARTY_MODULES>",
+    "interface",
+    "(?=content|api)",
+    "context/",
+    "mock/",
+    "config",
+    "utils/",
+    "hooks/",
+    "(components/|./index)",
+    ".svg",
+    "^../(.*)$",
+    "(?=./styles.module.scss)"
+  ],
+  "endOfLine": "auto",
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true,
+  "plugins": ["@trivago/prettier-plugin-sort-imports"]
+}

lesson_27/api/jest.config.js

@@ -0,0 +1,11 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+export default {
+  testEnvironment: 'node',
+  transform: {
+    '^.+.tsx?$': ['ts-jest', {useESM: true}],
+  },
+  moduleNameMapper: {
+    '^(\\.\\.?\\/.+)\\.js$': '$1',
+  },
+  extensionsToTreatAsEsm: ['.ts'],
+};