Just Be Funny 🎭🎉

Welcome to Just Be Funny (JBF) — an improv simulator game and comedy academy! This application provides an interactive environment for users to practice improv skills and learn about comedy.

Table of Contents

• Setup
  • Pre-requisite Software
  • Clone the Repository
  • Backend Setup
  • Running Simulators
• Requirements
  • Android Emulator
  • iOS Emulator
• Troubleshooting
• Additional Resources

---

Setup

1. Pre-requisite Software

Before setting up the project, ensure you have the following software installed:

• Homebrew: A package manager for macOS, used to install MongoDB and other dependencies.

  • Install Homebrew: https://brew.sh/

• MongoDB: A NoSQL database used by the backend.

  • Install MongoDB using Homebrew: brew tap mongodb/brew && brew install mongodb-community@8.0

• Xcode: Required for iOS simulator and iOS-related development.

  • Install Xcode from the Mac App Store: https://apps.apple.com/us/app/xcode/id497799835?mt=12

• Android Studio: Required for Android simulator and Android-related development.

  • Download Android Studio: https://developer.android.com/studio

Make sure all the required tools are properly installed and configured before proceeding with the setup.

2. Clone the Repository

First, clone the repository:

git clone https://github.com/akuligowski9/jbf
cd jbf

3. Install Dependencies

Next, install dependencies from the repository

npm install

4. Backend Setup

The backend relies on MongoDB for data storage and Node.js for server functionality.

1. Navigate to backend folder:

cd api

2. Start the backend server w/MongoDB:

npm run start:dev

Note: If MongoDB is already running:

npm start

The server should now be running on http://localhost:5001 with MongoDB connected.

5. Running Simulators

After opening Xcode and Android Studio, use the following commands in a separate terminal to start the simulators:

• Android:

npm run android

• iOS:

npm run ios

If the simulators don't start, ensure you have the appropriate Android and iOS SDKs installed, and check that the emulators are set up correctly.

Requirements

Android Emulator

• Device: Pixel 4 with API Level 35
• Android Version: 15.0

iOS Emulator

• Device: iPhone SE (3rd generation)
• iOS Version: 17.5

These configurations are recommended to match the optimal testing environment.

Troubleshooting

Here are some common issues and solutions:

MongoDB not starting:

• Ensure you have installed Homebrew and MongoDB correctly. Run brew services list to check the MongoDB status.
• If you get a "permission denied" error, try running sudo brew services start mongodb-community@8.0.

Backend server not running:

• Ensure you’ve started MongoDB first. Check the backend server logs for any errors.

Simulators not launching:

• Make sure Android Studio and Xcode are properly installed with the necessary SDKs.
• For Android: If you see a “No emulators found” error, create a new virtual device in Android Studio from the "Virtual Device Manager"

Additional Resources

Refer to the following documents for more detailed requirements, comedy content, and data references:

• MVP Requirements
• Comedy Category YouTube Library
• Misc JBF Data