This is the repository for the 310 group project. This basic skeleton provides two initial branches. documentation is for the group's Scrum process documentation. main is the primary branch for development work as described in the project manual.
All frontend code is located in /site. package.json contains frontend build configuration and a list of packages your frontend needs to install in order to run. You will need to download Node.js from https://nodejs.org/en/download/ to run the frontend independently. We recommend keeping top-level pages in /site/src/pages and other components in /site/src/components, although you are free to structure your frontend as you see fit.
All backend code is located in /src/main. You can find a demo endpoint located in /demo/api. Please do not remove redirect() from SpringBootAPI.java, as this is responsible for enabling your website files to be served. A reminder that Java 17 is required on your machine to run/compile SpringBoot.
All unit tests will run with mvn test and the coverage output directory will be target/site/jacoco for your Java code and site/coverage for your JavaScript code.
To run just your frontend tests:
- First, navigate in your terminal/command prompt to
/site. - Run
npm run testto run Jest tests- This will ask you to select an option:
awill run all tests,fwill run failed tests, etc
- This will ask you to select an option:
- Run
npm run test -- --coverage --watchAll=falseto run Jest coverage tests. Note the extra--is required.
To run the app in the development environment, first run mvn compile and then mvn spring-boot:run The app will now be available on http://localhost:8080
- Navigate to
/sitein terminal/command prompt - Run
npm start. Note that this will auto rebuild/refresh when you make changes to the frontend.
- Run the main method in
SpringBootAPI.java
To run the project's acceptance tests, either mvn integration-test or mvn verify can be run. Cucumber can be configured to run a subset of the features by modifying the cucumber.properties file in the src/test/resources folder
The container can be run with docker-compose run 310-project This opens up a bash prompt, then the web app can be compiled with mvn compile and run with mvn spring-boot:run The app will then be available on localhost:8080. Note that the container must be configured by the group so it contains all dependencies and environmental configuration necessary for the CP stakeholder to run and interact with the app. Remember to stop the container to be able to run the app in the development environment. Without doing so, the OS will report that port 8080 is in use.
- Jest
- https://jestjs.io/docs/getting-started
- https://jestjs.io/docs/tutorial-react
- https://www.codecademy.com/learn/learn-react-testing
- React
- https://reactjs.org/tutorial/tutorial.html
- https://reactjs.org/docs/react-api.html
- https://reactjs.org/docs/hooks-intro.html
- https://reactjs.org/docs/jsx-in-depth.html
- https://www.w3schools.com/REACT/DEFAULT.ASP
- Frontend Styling Libraries
- https://tailwindcss.com/docs/guides/create-react-app
- Start on Step 2 for installation
- Search page for relevant styles/class names
- https://getbootstrap.com/docs/5.3/getting-started/introduction/
- Search page for relevant styles/class names
- Cucumber related information
- Gherkin information: https://cucumber.io/docs/gherkin/reference/
- Cucumber information: https://cucumber.io/docs/cucumber/
- Selenium information: https://www.selenium.dev/documentation/en/ and https://www.selenium.dev/selenium/docs/api/java/
- JUnit
- https://junit.org/junit4/
- https://site.mockito.org/
- https://www.eclemma.org/jacoco/trunk/doc/maven.html
- SpringBoot