What is Campus Connect?

Campus Connect is a cross-platform chat and social media app developed by USC students, for USC students. Join your friends. Talk about classes. Post your favorite links. Whatever!

Hardware Requirements

This dev environment is very intensive and will require a modern computer with at least 20gb of free space, 16gb of ram, and a 4 or more core processor from the past few years.

iOS Development requires a Macintosh Computer.

We recommend a beefy desktop computer for Android Development and an M1 Mac for iOS development.

Setup and Running

1. Clone Repo
2. Follow instructions to setup react native cli here https://reactnative.dev/docs/environment-setup
3. Install Dependencies

   npm update

4. Run the code

   npx react-native run-android

All the source files for the project are in the "src" folder

Deployment

We will publish an apk/ipa onto github.

Testing

Testing Technology

We are using jest and detox to test our software. Several unit tests, as well as functional tests will be available for code review.

Jest unit tests are located in __tests__ and behavioral tests are located in e2e

Running Tests

Unit Tests

Run npm test from the root directory to run the unit tests.

Behavioural Tests

Detox behavioral tests can be run by performing the following steps:

1. Follow these steps
2. Run npm start in a separate terminal window.
3. Compile the debug binary with detox build --configuration android.emu.debug ¹
4. Run the tests with detox test --configuration android.emu.debug

Authors

Erik - [email protected]
Coby - [email protected]
Neekon - [email protected]
Timothy - [email protected]
Chase - [email protected]

Footnotes

1. This command does not work on Mac OS at the moment. You will have to compile manually if you know how. ↩