SewaneeRooms is a mobile application designed to help students at Sewanee University find and participate in study groups on campus. It provides features such as room creation, profile management, and real-time location-based study room listings.
- User Authentication: Sign up, log in, and manage user profiles.
- Email Verification: Ensure that all user accounts are verified via email.
- Study Room Management: Users can create, join, or leave study rooms.
- Real-Time Updates: Users receive updates on rooms they've joined or are interested in.
- Location Services: View study rooms available around the campus on a map.
- React Native: For building the mobile application.
- Firebase: For authentication, database management, and hosting.
- React Navigation: Used for managing navigation between different screens.
To run SewaneeRooms on your local machine, follow these steps:
- Node.js
- npm or yarn
- React Native CLI
- An Android or iOS device or emulator
-
Clone the repository git clone https://github.com/yourgithub/sewaneerooms.git cd sewaneerooms
-
Install dependencies
npm installor
yarn install -
Set up Firebase
- Create a Firebase project at Firebase Console
- Add your app's Firebase configuration to
src/firebaseConfig.js
- Run the Application
- For Android:
npx react-native run-android - For iOS:
cd ios && pod install && cd .. npx react-native run-ios
Create a new account and verify your email to get started.
Log into the app using your credentials.
Use the 'Create Study Room' feature to set up a new room or join existing ones through the 'Study Room List'.
Update your profile information in the 'Profile' section.
Use the 'Map' feature to find study rooms around the campus.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.