Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mtalhahabib authored Jan 15, 2024
1 parent fad9883 commit fdc963c
Showing 1 changed file with 56 additions and 9 deletions.
65 changes: 56 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,63 @@
# web_project
# Mandoob App

A new Flutter project.
Welcome to Mandoob, your go-to app for seamless event management and effortless contact saving!

## Features

### User Types

- **Organizer:**
- Create and manage events.
- View a list of attendees for each event.
- Create and store event-specific notes.

- **Attendee:**
- Access a personalized dashboard displaying all available events.
- Register for events with a simple click.
- Gain instant access to event notes upon registration.
- Convenient reminder page for all registered events.

![1](https://github.com/mtalhahabib/Mandoob/assets/96326069/809bacb0-804f-4b82-9c54-613e4d6962eb)

![2](https://github.com/mtalhahabib/Mandoob/assets/96326069/7f462d57-41bb-4fcf-af15-5bba8081a90b)


### Handwritten Contact Scanner

- Mandoob takes the hassle out of saving handwritten contacts.
- Simply snap a picture of a page with phone numbers and contacts.
- Mandoob extracts and displays names and numbers.
- Edit names or numbers as needed.
- Save all contacts to your phone's contact book with just one click.
Demo Video is present here on this link
https://drive.google.com/file/d/1WKwqC-MiDhAZl2VyDktf-lau5XFL6gWV/view?usp=sharing

## Getting Started

This project is a starting point for a Flutter application.
1. **Clone the Repository:**

git clone https://github.com/mtalhahabib/Mandoob.git

2. **Add Key.Json file to asset folder:**

You have to enable google cloud vision Api. From there you will get key.josn file
which you have to add to your asset folder to use Hand Written Contact Scanner

4. **Explore and Enjoy:**
- Organizers can create and manage events.
- Attendees can register for events, access notes, and set reminders.
- The contact scanner simplifies saving handwritten contacts.

## Feedback

We value your feedback! If you encounter any issues or have suggestions for improvement, please [open an issue](https://github.com/your-username/mandoob/issues).

## Contributing

We welcome contributions! Please follow our [contribution guidelines](CONTRIBUTING.md) to get started.

A few resources to get you started if this is your first Flutter project:
## License

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
This project is licensed under the [MIT License](LICENSE.md) - see the [LICENSE.md](LICENSE.md) file for details.

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
Happy organizing and networking with Mandoob! 🚀

0 comments on commit fdc963c

Please sign in to comment.