CollegeCupid

CollegeCupid is a Flutter app designed to help college students connect with one another. CollegeCupid aims to make the process of matching wih your crushes within your college community easy and fun.

UI Design

Look at the design here

Getting Started

Before you can start contributing to CollegeCupid, you need to set up your development environment. Follow these steps to get started:

Prerequisites

1. Flutter: Ensure you have Flutter installed. You can find installation instructions here.

2. Git: Make sure you have Git installed. If not, you can download it here.

3. GitHub Account: You will need a GitHub account to contribute to this project. If you don't have one, you can sign up here.

Fork the Repository

1. Fork the CollegeCupid repository to your GitHub account by clicking the "Fork" button on the top-right corner of the repository page.

Clone Your Fork

1. Clone your forked repository to your local machine using the following command:

   git clone https://github.com/<Your Github username>/college_cupid.git

Install Dependencies

1. Navigate to the project directory and install the required dependencies using Flutter's package manager:

   cd college_cupid
   flutter pub get

Run the App

1. You can now run the app on an emulator or a physical device using the following command:

   flutter run --dart-define SECURITY_KEY="Cupid-Dev" --dart-define API_URL="https://swc.iitg.ac.in/test/collegeCupid/api/v2" --dart-define BASE_URL="https://swc.iitg.ac.in/test/collegeCupid"

Contributing

We welcome all contributions, big or small. Here's how you can contribute to CollegeCupid:

1. Pick an Issue: Check out our Issues page to find a task that interests you.

2. Make Changes: Make your changes or improvements to the code.

3. Test Locally: Ensure that your changes work as expected and do not introduce any new issues.

4. Commit Changes: Commit your changes with a clear and concise commit message.

5. Push Changes: Push your changes to your fork on GitHub.

6. Create a Pull Request: Open a pull request from your fork to the dev branch of the original repository.

7. Review and Feedback: Your pull request will be reviewed by our team. Make any necessary changes based on feedback.

8. Merge: Once your pull request is approved, it will be merged into the main project.

Happy Hacking!

Thank you for participating in CollegeCupid's Hacktoberfest. We appreciate your contributions, and together, we can make CollegeCupid even better for college students everywhere. If you have any questions or need assistance, feel free to reach out to us via GitHub issues or our community chat.

Happy coding! 🚀🎉