Food App is Online Food Delivery App developed with Flutter. Created with Flutter 💙 version 3 with a good design source. We are open and welcome any contribution to this project. Before you start to contribute, you can read all the documentation below. Happy coding 👊🏻
Development Environment Preparation
- Install Flutter, we recommend installing Flutter with version 3 or higher.
- Install Android Studio to get the SDK and to be able to use the emulator for running the App.
- Download the UI design on this link.
- Congrats! You are ready to make a contribution. How can I contribute?
Directory Structure
This is the directory structure of the Food App. Currently, we have 2 main folders inside the lib folder, ui and utils folder. It can be added depending on what we need on the projects, for example, the data or repository folder.
This is a brief explanation about the folder.
| Directory | Description |
|---|---|
| lib/ | Application core scripts |
| lib/ui | Application UI screens/pages widgets and widgets |
| lib/ui/pages | All UI screens/pages widgets |
| lib/ui/widgets | All UI widgets |
| lib/utils | Application styles related scripts and Miscellaneous utility script |
We can use dependencies/packages from any source such as pub.dev. This is a list of packages that currently we used on the project.
| Dependency | Description |
|---|---|
| cupertino_icons | iOS style icons (Dependency packaged with flutter sdk) |
| google_fonts | A Flutter package to use fonts from fonts.google.com |
All apps will use routing for navigating to some screen or page. This is our routes on the project.
| Route | Key | Screen | Related screen |
|---|---|---|---|
| examplePage | example_page | ExamplePage | Example Screen for displaying app color and app typography |
| mainPage | main_page | MainPage | Main Page screen or we can call it home screen |
In this project, we try to organize all the base sources like color, routes, and typography as well as we can. So we can easily use them for any screen widgets or widgets we want. The developer should follow the below-mentioned instruction when developing a new widget or modifying any part of the Food App.
-
AppColors (
lib/utils/app_color.dart) :- This is the primary script/code that manages the application color scheme. Therefore, the developer should stick with the pre-defined color scheme. If there is a need to introduce a new color, it must be handled through this script. We can declare a new color in this file. -
AppRouter :- We can declare all the screens with each data for what we need on this file to make it easy to implement the navigation.
-
AppTypography :- This is the primary script/code that manages the application typography. We used Poppins as a base font family. If there is a need to introduce a new font family or font size and color to easily use it, it must be handled through this script.
This the example page looks like:
Before you start making contribution make these things clear
- Dont make spam PR's like just add adding (.) and spaces in the file.
- Make sure you add some value to the repository.
- Spam PR's wont get merged
- Go click and check the link above "How can I contribute?" 🙌
- Make Sure you commit your changes in a new branch.
- Make Sure you Give proper name to your files describing the addition.
- Also Make Sure you comment your code wherever necessary.
- And last but not least, don't forget to read and keep updated with the documentation of the project above after you made your changes/modifications.
After a valid pull request, your code will be carefully reviewed and if it matches the rule then it will be accepted otherwise you need to generate a new file. This process may take some time but don't worry.
