raghavsharma1472 / recipebookflutter Goto Github PK

Is your feature request related to a problem? Please describe.
Sometimes pull requests are not well written and are not easily comprehensible. Some people send pull request without stating the issue they are solving.

Describe the solution you'd like
Make a pull request template so that we can ensure better workflow and get the required information about pr from a contributor.

Describe alternatives you've considered
I considered the alternative of making contributing.md file. However, it is easy for a person to forget the guidelines there. Moreover by providing essential checklist while pr can help to avoid merge conflicts later on.

Approach to be followed (optional)

1. Make a template suitable for PR requests.
2. Add a checklist of essential items to consider before submitting the pull requests.

Additional context (optional)
Can I work on this issue?

We could add a functionality to make the app run in only Portrait mode.
As landscape mode doesn't provide any real advantage in the Recipe app.

The current Readme file is very suttle and is hard for beginners to get stared .
So can I improve it making it more attractive, adding images and adding a getting started guide

Add an animation in the splash screen, as the current one is just a logo which is a little boring and also serves no purpose of using a framework like FLutter in building the app

Here we will display 10 dishes in the first page with image, name and rating. Just have to link the class of Data converted with the list views, taking care of the geometry of containers in the list.

We can Create a Splash Screen (Screen shown for 4-5 sec while opening an app), it can be just an image reflecting what's inside the app, could also have some animation if you want it to look fancy.

Try to build the UI of the first page using ListViews. Adjust the Scrollable physics and place the search bar at the top. We have to have an App Bar in the App so should account for that. Be Innovative

Is your feature request related to a problem? Please describe.
Every open source project has its own guidelines and uses for contributing. So RecipeBookFlutter should have its own CONTRIBUTING.md file.

Describe the solution you'd like
I could make a CONTRIBUTING.md file for documentation purpose

Describe alternatives you've considered
Adding extra information in README.md

Approach to be followed (optional)

• Add steps for making a PR from scratch.

• Add general rules for contributing/raising issues.

• Add best practises to make a good pull request.

Additional context (optional)

We could add a functionality to make the app run in only Portrait mode. As landscape mode doesn't provide any real advantage in the Recipe app.

In this App we will use https://www.food2fork.ca/ website to fetch data. So in the above issue we received data, now its the time to convert it into some class data. Streams can be used here but preferably you should go with real time HTTP data to be converted into class data and shown in the UI using the List Views. So Here try to get the Algorithm to convert the HTTP data into a class object which can show the data in the UI. NOTE: we will only be displaying 50 dishes a page at max.

Can I work on making an issue template suitable for this project?

Try to push a newly made flutter code in the repo. You may delete the default code provided by flutter.

Try to make a bunch of files which can retract the HTTP data into the app. We will use these files to get the data of the dishes data online available in form of APIs. Have to be clean and minimal in amount of code.

It would be really nice to have an animation

This add to menu also allow the user to view the recipe when they are offline also