Flatmate Finder

live demo ↗

built with Vite & hosted by Vercel

---

Tech Used in this Project

---

Brief Introduction:

Flatmate Finder streamlines the flatmate search process with its user-friendly form for potential flatmates. The submitted data is securely stored via Firebase, ensuring privacy and security. Tenants can then conveniently evaluate and rank applicants using a Tinder-like interface.

Built with Vite, TypeScript, Firebase, and Tailwind CSS, Flatmate Finder delivers a seamless user experience for both potential flatmates and current tenants.

Click here for screenshots:

How It Works

For Potential Flatmates

1. Form Submission: Fill out the comprehensive form, providing necessary details and preferences.
2. Data Storage: Submitted data is securely stored on Firebase.

For Current Tenants

1. Profile Viewing: Access the application to view profiles in a Tinder-like interface.
2. Rating System: Rate potential flatmates based on preferences and interactions.
3. Leaderboard: See the most popular options based on tenant ratings.

Contributing

Contributions are welcome! If you'd like to enhance the application or fix bugs, please follow the standard GitHub flow: fork, create a branch, commit changes, and open a pull request.

Found a Bug?

If you've encountered a bug or issue with Flatmate Finder, we appreciate your help in improving the application. Before filing a new issue, please check if there's already an existing one here to avoid duplication.

How to Report a Bug:

Click here to expand

1. Go to the Issues page.
2. Check if the bug has already been reported.
3. If not, click on the "New Issue" button.
4. Provide a clear and concise title and description of the bug.
5. Include steps to reproduce the issue if possible.
6. Add relevant labels and submit your issue.

Your contribution helps us maintain a stable and reliable application. Thank you for your support!

Running Locally

While you can explore the live demo, you also have the option to clone and run the application on your local machine. This gives you more flexibility for testing and customization.

Click here to expand

Prerequisites

Before getting started, make sure you have Node.js installed on your machine. You can download it from here.

Installation Steps

1. Clone the Repository:

   git clone git@github.com:DevonGifford/FlatmateFinder.git

2. Install Dependencies:

   cd flatmate-finder
   npm install

3. Firebase Configuration:

   • Set up your Firebase project and obtain the necessary credentials.
   • Update the Firebase configuration in the project.

4. Run the Application:

   npm run dev

   This command will start the development server, and you can access the application locally at http://localhost:3000.

Notes

• Ensure that your Firebase configuration is correctly set up to enable features such as data storage and retrieval.
• You will find firebase mock data as well as function for seeding said mockdata to get started quickly.
• If you encounter any issues during installation, please check the Issues page for existing solutions or create a new issue if needed.

License

This project is licensed under the MIT License.

Acknowledgments

Special thanks to Vite, TypeScript, Firebase, Tailwind CSS and ShadCN for enabling the development of this application.