kiarash-nazari / Tagify

Tagify 💬

       

Tagify enables the user to create and manage groups with ease. It lets the user find the right set of people and communicate relevant information with them.

• After creating an account, users can assign themselves tags, for e.g. appdev, rajasthan, burger, etc.
• Say we want to address everyone who is in Rajasthan and likes Burger or is in Assam and likes Fish, then we can simply create a group with this logic: (rajasthan AND burger) OR (assam AND fish) which is equivalent to (rajasthan & burger) | (assam & fish) and a group with those people will automatically be made!
• To enter the logic for a group, we are using a bunch of buckets, there can be any number of buckets, and each bucket can contain any number of tags. The tags inside a bucket are ANDed, and then the buckets are ORed together.
• Here is a presentation explaining the working of the app with screenshots.
• Here is a video demonstrating the app.

Setting up the project in your local environment💻

1. Fork this repository.
2. Clone the forked repository:

git clone https://github.com/<your username>/Tagify
cd Tagify

3. Add a remote to the upstream repository:

# Typing the command below should show you only 1 remote named origin with the URL of your forked repository
git remote -v
# Adding a remote for the upstream repository
git remote add upstream https://github.com/letsintegreat/Tagify

4. Get Flutter and Firebase CLI if you don't already have them.
5. Run flutter pub get to get the dependencies.
6. If you have not yet logged into Firebase CLI and activate FlutterFire CLI globally:

firebase login
dart pub global activate flutterfire_cli

7. Create a new project on Firebase Console, activate Google Sign In, and activate Firebase Firestore in test mode.
8. Configure your flutter app with the newly created project on firebase console:

flutterfire configure

This automatically registers your per-platform apps with Firebase and adds a lib/firebase_options.dart configuration file to your Flutter project.

9. Finally, run the app:

flutter run

Contributing to the project 🛠

Now that you have the project set up in your local environment, follow the steps below to contribute!

1. Take up an already existing issue or create a new (but a valid) one via issue tracker.
2. Pull the latest code in.

# Make sure you are on the main branch
git pull upstream main

3. Create a new branch.

# Replace xx with the issue number you are working on and give your branch a good name
git checkout -b issue-xx-a-good-name

4. Make your changes!
5. Once done with a particular feature, bug fix, or a documentation part, add your changes to the staging area. Please don't add lib/firebase_options.dart file to your commit, it is meant to be kept as a secret.

git add .

6. Review and commit your changes.

# The message should be in present tense, for ex - "Added feature x" is not ideal but "Add feature X" is
git commit -m "a meaningful message"

7. Push your changes!

git push --set-upstream origin <your-branch-name>

8. Create a pull request from GitHub and wait for the review!

Contributions of any kind welcome!

Authors

This project was developed under a hackathon by

• Harshit Seksaria
• Priyanshu Srivastava
• Nishchay Nilabh