The repository is primarily organized by functionality, with the main sections being frontend, backend, and database. A short description of each internal folder is provided below:
The Frontend folder stores all code relevant to the frontend of the project. This includes JS files, CSS files, markup, and more. As a general rule, the Frontend folder contains the code that the client will interact with (e.g., GUI). The Frontend folder should not store any of the project's functional Backend, which the user does not see.
The Backend folder stores all code relevant to the backend of the project. This code is more functional than the frontend and is not accessible to the user. Instead, the Backend folder contains the code necessary for the application to operate properly (e.g., user-matching algorithms). For this project, backend code is primarily written in Java. The Backend folder also contains subfolders separating the Java code from its test suites (see ./backend/README.md for more).
The Database folder holds SQL to manipulate the database. This includes a SQL file to create the database, files to test the database, and more.
The Prototypes folder stores semi-relevant code that demonstrates a core project function. For example, the "googleAPI-tutorial.js" file demonstrates how to use the Google Books API to fetch information used in the app. Although the exact implementations are not used directly in the app, they depict how the necessary tools function.
The Reports folder stores the weekly project report markdown files. These reports provide status updates for the TAs and outlines the next project meeting. Additionally, the reports have weekly goals, progress reports, and future goals for next week.
This project has implemented branch protection. Contributors to the main branch must submit requests for their code to be reviewed before merging into the main branch.
The main BookBae project has a "Projects" tab which outlines the milestones within the course (e.g., System Architecture, Testing, etc.). Each project milestone will detail the individual/group tasks necessary, as well as a task's status.
These are the set up instructions to set up an instance of our server. For the final turn in, we will host the server on Azure.
-
Build the backend .war file
- In command line, navigate to the backend folder
- run "./gradlew build" this command will build an .war file called api.war within backend/build/libs
-
Download Glassfish, our interim server, and start the server
- Go to https://projects.eclipse.org/projects/ee4j.glassfish/downloads and download Glassfish version 6.2.5 Full Profile
- Extract the glassfish-6.2.5.zip to a safe place
- In command line, navigate to the glassfish-6.2.5 folder
- In command line, run the following command: On Unix: glassfish6/glassfish/bin/asadmin start-domain On Windows: glassfish6\glassfish\bin\asadmin start-domain
-
Upload the .war file
- In your browser, navigate to localhost:4848. This will pull up the Glassfish configuration portal
- On the left navigation bar, click "Application" to navigate to the application page
- Click "deploy". This will prompt you to upload a .war file. Chose the api.war file within backend/build/libs
- In the "Context Path" blank, write "/api"
- Click "Ok" to save
-
Configure properties
- On the left navigation bar, click "server-config". It is the last option.
- Click JVM Settings
- Click the JVM Options tab
- delete the javax.net.ssl.keyStore and javax.net.ssl.trustStore properties
- Add the following four properties. Contact BookBae team for password. "-Dbookbae.server_url=bookbaeserver.database.windows.net' "-Dbookbae.database_name=BookBaeDB' "-Dbookbae.username=TeamBookBae@bookbaeserver' "-Dbookbae.password='
- Click "Ok" to save
- Press the "Restart Server" button to save changes
At this point your server is set up and ready to take requests!
-
(Optional) Test your server connection
- From the Application page (Click "Application" on left navigation tab)
- Click "Launch". This will load a page with two launch links to choose from.
- Click the first link, the one at port 8080
- add "/v1/user" to the url
- If you see a 401 server error (as opposed to a 404 server error) you are properly configured. At this point, the server is denying your request only because you have not provided the appropriate token.
These are the setup instructions for the frontend components. These let a user run the application on an android device or an emulator in Android Studio.
Setup For Emulator: Create an Android Virtual Device (AVD) in Android Studio to run the application (recommended: Pixel_3a).
Setup for Real Device: Plug the device into your computer that you are using to run Android Studio.
Starting the app:
-
From the top level "BookBae" in the repository, enter the frontend section by running "cd ./frontend/BookBae" in the command line.
-
In the command line, run "npm install" to add the necessary dependencies to the local repository.
-
Run "npx react-native run-android" in the command line to start the application (should open emulator or switch to app screen on real device)
-
(Optional) Testing the application:
- run "npm ci" to add the Jest testing setup.
- run "npm test" to run tests.
- Note: all tests run automatically when changes are pushed to branches/main via continuous integration, which is why testing in the local repository is optional.
-
(POSSIBLE ERROR) ERROR: JAVA_HOME is set to an invalid directory:
The following error occurs if the JDK is not properly setup for the Android Studio environment. To fix this issue...
For MacOS, if using Catalina and above...
-
In the command line, run "vim ~/.zshrc"
-
Add the following lines to the file:
export ANDROID_SDK_ROOT=$HOME/Library/Android/sdk
export PATH=$PATH:$ANDROID_SDK_ROOT/emulator
export PATH=$PATH:$ANDROID_SDK_ROOT/platform-tools
For other versions of MacOS, follow the instructions here: https://stackoverflow.com/questions/43211282/using-jdk-that-is-bundled-inside-android-studio-as-java-home-on-mac
For Windows, ensure the Android Studio environment is properly setup with a valid path for JDK.
As briefly described above, the repository has implemented continuous integration to test commits/merges to the project. Pull requests and conflicts are resolved by other users (user who made pull request cannot also be the reviewer) to ensure all code is properly reviewed. See the optional testing sections above, and the testing portion of the living document, for further details regarding test types, build system, and more. The continuous integration uses GitHub Actions to catch any potential bugs within the code. In doing so, code is checked immediately before any further damage can be dealt.
This section outlines which use cases described from the Living Document are operational in the current implementation.
-
User wishes to connect with prospective dates using BookBae: NOT OPERATIONAL Although all the necessary components have been outlined, they are not fully linked and operational to meet the definition of the use case.
-
User wishes to connect with new friends using BookBae: NOT OPERATIONAL Similarly to (1) the features have been established, but are not yet operational.
-
User wants to browse profiles, not necessarily trying to find a match: SEMI-OPERATIONAL The app currently provides fake sample data when logging in, displaying how real matches will be viewed in the future. The implementation should occur easily and quickly after the necessary endpoints are established in the database.
-
User wants to start a conversation with a match: NOT OPERATIONAL The messaging screen has been outlined, with established endpoints in the backend, but it has not yet been linked to its corresponding frontend components.
-
User wants to explore the app to see if they might like it: OPERATIONAL Onboarding process is fully implemented, allowing user to design their profiles and explore the various screens within the app.