cse-110-project-team-40

REPO LINK https://github.com/ucsd-cse110-fa23/cse-110-project-team-40 https://github.com/ucsd-cse110-fa23/cse-110-project-team-40

What has moved

• All root-level files are contained in app, like config.json, output.wav, etc
• There is no longer a makefile - we are using ./gradlew instead. The definitions for the tasks that ./gradlew can do is in app/build.gradle
• spotless is a gradle library that does Google Style
• All tests are run through a single command ./gradlew test
• Run GUI: ./gradlew run
• Run Server: ./gradlew runServer
• Format automatically ./gradlew format
• Clear Files: ./gradlew clean

How to Build from Scratch

1. Install Java JDK - tested on versions 11 and 17
   • Verify by typing java --version
2. Install gradle
   • Verify by typing gradle --version
3. Clone this repository
   • git clone https://github.com/ucsd-cse110-fa23/cse-110-project-team-40
   • Clone a branch: git clone -b new-build-system https://github.com/ucsd-cse110-fa23/cse-110-project-team-40
4. Set up MongoDB (Cloud Instructions, adapted from Lab 6)
   • Create a MongoDB account
   • Create a (Shared) database cluster of any name
   • On database, Connect -> Drivers -> Java 4.3 -> copy the connection string
   • Paste it into app/config.json - MongoDBURI
   • Go to Database Acccess on the left pane
   • Add a new user of any name/password
   • Replace the <username> and <password> fields in the MongoDBURI config
   • Go to Network Access, add your IP (may need to do whenever your wifi changes)
   • Set app/config.json - MongoDBDatabase to the name of your database
5. Set up OpenAI API
   • Create an OpenAI account
   • Go to https://platform.openai.com/api-keys
   • Create an API key
   • Copy the key into app/config.json - OpenAiApiKey
6. Do not commit your modified app/config.json to Github
7. (if running client locally) Set "RemoteServerIP": in config.json to the server which you would like to connect to
8. (if running Server locally) Set "HostName": in config.json to your current ip

How to run

• Run the GUI app ./gradlew run
• Run the server (must be running for the app to work) ./gradlew runServer
• Run all tests ./gradlew test
• Delete all build files ./gradlew clean

Style

• Uses Google Style Guide
• Indentation is 2 spaces
• View style issues ./gradlew lint
• Automatically fix style issues ./gradlew format

Example config

{
  "OpenAiApiKey": "sk-abcdefghijklmnopqrstuvwxyz",
  "MongoDBDatabase": "cluster0",
  "MongoDBURI":"mongodb+srv://username:[email protected]/"
  "RemoteServerIP": "222.222.22.221",
  "HostName": "222.222.22.223"
}

VSCode launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Run Server",
            "command": "./gradlew runServer",
            "request": "launch",
            "type": "node-terminal"
        },
        {
            "name": "Run GUI",
            "command": "./gradlew run",
            "request": "launch",
            "type": "node-terminal"
        }, 
        {
            "name": "Format Code",
            "command": "./gradlew format",
            "request": "launch",
            "type": "node-terminal"
        }
    ]
}