Homie is a mobile application for finding your future roommate and/or soulmate. It is dedicated for students who want to find a perfect person to share a room with in the future. Our app is quintessential platform to look for other students' shared accommodation offers and for posting your own room-sharing proposal. Thanks to Homie you can find a roommate that matches your hobbies and interests, and that you certainly will get along with.
To install Homie you will need a device with iOS or Android operating system. Internet connection and third part app: Expo Go are required.
You can install Expo Go on your IOS or Android device and subsequently run our application by scanning QR code from the special link sent to you (you can get it from one of projects contributors).
In the future we are planning to deploy our app to Google Play and App Store, to enable quick and effortless installation and usage. Going forward we would like to add possibility to find a roommate to your own flat and enable looking for residents to your own flat.
We'd love to have your helping hand on Homie app! Any help with issues and pull requests are always appreciated. Please contact any of our maintainers for more information on what we're looking for and how to get started.
Launching an application moves you to Login Screen. You can log in with an existing account or create one by clicking at 'Register here' button. Registration requires your: e-mail, password, full name and year of study. After registration, you can log in with your account.
Login screen:
- If you already have created account -> enter valid email and password
- Log in by pressing on "Confirm" button
- Register button
- If you forget the password, you can click 'Forgot password' button to get a 'reset password link' sent to your e-mail adress( don't forget to fill-in an e-mail box before clicking on the button😉).
Register screen:
- You can go back to Login screen by pressing the arrow icon on the left top corner.
- Fill up all necessary data.
- Create account.
After succesful log in, you will be redirected to Main Screen 🏠. Here, at the top of the screen, You can see Your personal information.
- You can click 'Edit Profile' button to edit and fill-in Your profile information (complete Your profile is required for correct posting an offer!).
- Clicking a star icon ⭐️ next to "Edit Profile", you can move to the list of your favourite offers.
Below You can see a list of all posted offers which can be filtered out using 'Select filter' (5). You can certainly see any offer that interests you by clicking an arrow at the buttom of each offer (3). Clicking a star icon ⭐️ on the offer add it to your 'Favourites offers' (4).
On the bottom of the screen you can see tab navigation bar:
- Home icon 🏠 takes you to main screen.
- Plus icon ➕ navigates you page where you can add new offer.
- Profile icon 👤 takes you to your profile page where you can see detiles about your profile.
- You can go back to Main Screen 🏠 by pressing the arrow icon on the top-left corner.
- Fill up all data you want to change.
- Select image which you want to make your profile picture.
- Select your interests.
- Save your changes.
You can add Your new offer using ➕ button on the bottom. Here you need to provide all required data like offer title, description and location of a desired dormitory (location is optional; you can leave this record empty if You're not sure which you prefer ). After clicking 'Create offer' button your offer will be visible to all the users. You can see your offers by clicking profile icon at the bottom and selecting 'My offers'.
On the right bottom corner is a button 👤, that moves you to Your Profile Screen.
- There you can see all your favourite offers.
- Here you can see and delete all the offers you posted.
- Thats a button that lets you log out of the app.
My Offers screen:
- You can go back to Profile Screen 👤 by pressing the arrow icon on the left top corner.
- Delete your offer.
- Show details about your offer.
My Favoutire Offers screen:
- You can go back to previous screen by pressing the arrow icon on the left top corner.
- Unlike the offer by clicking a star icon ⭐️.
- Show details about offer.
You can get here by clicking down-arrow on any offer card. This screen constains more information about chosen offer. On top you can see information about creator, offer's title and its description.
- You can go back to previous screen by pressing the arrow icon on the left top corner.
- You can change images added to the offer, using arrows
Documentation here
This project is being maintained by four friends from AGH - University of Science and Technology in Cracow:
Homie is MIT licensed, as found in the LICENSE file.