diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..8983ea2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Muhammad Furqan + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index ec5ad01..e7d388b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ # Flutter E-Commerce UI KIT -A new Flutter application. +A powerful Flutter E-Commerce starter template that bootstraps development of your mobile application. Flutter E-Commerce Starter is a mobile application template with lots of built-in components like sidebar, navigation, slider, cards, form elements, etc - all you need to start building your mobile app faster. Check out demo + +![](demo/full.gif) + +## What's inside + +- Simple navigation +- More than 5 Ready-to-use Pages + ## Getting Started -This project is a starting point for a Flutter application. +#### 1. Clone and Install + +```bash +# Clone the repo +git clone https://github.com/Furqankhanzada/flutter_eCommerce_ui_kit.git + +# Navigate to clonned folder and Install dependencies +cd flutter_eCommerce_ui_kit && flutter packages get +``` + +## Contributing + +If you find any problems, please [open an issue](https://github.com/Furqankhanzada/flutter_eCommerce_ui_kit/issues/new) or submit a fix as a pull request. -A few resources to get you started if this is your first Flutter project: -- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook) +## License -For help getting started with Flutter, view our -[online documentation](https://flutter.dev/docs), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +[MIT License](LICENSE) \ No newline at end of file diff --git a/demo/full.gif b/demo/full.gif new file mode 100644 index 0000000..f2e0e8a Binary files /dev/null and b/demo/full.gif differ