hotdeals
hotdeals is an online marketplace app developed with Flutter.
The app's Backend can be found here.
Table of Contents
- Screenshots
- Features
- Getting Started
- Usage
- Roadmap
- Code Contributors
- Contributing
- Author
- License
- Acknowledgements
Screenshots
Features
- CRUD deals
- Favorite, vote and comment on deals
- Search as you type & Faceted search (using Elasticsearch)
- In-app Chat (using Firebase Firestore and flutter_chat_ui)
- Social Login with Facebook and Google (using Firebase Authentication)
- Push notifications (using Firebase Cloud Messaging)
- State management with riverpod
- Routing with *go_router
- Infinite Scrolling Pagination (using infinite_scroll_pagination)
- Light and Dark themes
- Localization
- Logging (using loggy and Firebase Crashlytics)
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
- You need to have Flutter installed on your pc.
- You need to have hotdeals-backend ready in your system.
Installation
- Clone the repo using:
git clone https://github.com/halildurmus/hotdeals.git
- Register the app on Firebase.
- To register your app with Firebase, follow the instructions in here
- If you want to support Facebook Login, follow the instructions in here.
- The environment configuration will be read from
config/dev_config.dart
by default unless you specify the environment using--dart-define=ENV=prod
in the run args. Depending your environment, you may need to changeapiBaseUrl
inside thedev_config.dart
. - To get the packages needed for the app, run:
flutter pub get
Usage
If you have a connected device or emulator running, you can run the app with:
flutter run
Roadmap
See the open issues for a list of proposed features (and known issues).
Code Contributors
This project exists thanks to all the people who contribute.
🤝 Contributing
Contributions, issues and feature requests are welcome. Feel free to check issues page if you want to contribute.
Author
👤 Halil İbrahim Durmuş
- Github: @halildurmus
📝 License
This project is MIT licensed.
Acknowledgements
- Country Icons made by Freepik from www.flaticon.com
- Img Shields
- Preview mockups were created with AppMockUp