Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/moak13/recipe_app

A simple recipe application
https://github.com/moak13/recipe_app

Last synced: 2 months ago
JSON representation

A simple recipe application

Awesome Lists containing this project

README

        

# receipe_app

How to contribute to this open source project
Prerequisites
* You will need to have [flutter](https://docs.flutter.dev/get-started/install) set up on your system
* You Should know this project was built using stacked as a state management tool check this for info on [stacked](https://stacked.filledstacks.com/docs/getting-started/overview/)

Installation

To get started with the code follow this steps

1. Fork my repo

...
click the fork button on the top right corner and give it a name you want
...
2. clone your fork

2. Navigate to the project directory

....//TODO
cd recipe_app
.....

3. clean the app by running the flutter clean

....
flutter clean
....

4. run the app

....
flutter run
....

5. make changes

6. create a branch

7. checkout to your branch

8. commit changes

9. push your code

## GitHub Contribution

To contribute to this project, features are added via PRs. The guideline for PRs are one PR per feature. Features can be a screen, backend integration or a bug fix. When creating a branch that later turns into a PR, kindly make use of this formats in branch formats below.

## Branch Formats

Below are the formats to use when contributing to this project.

- feat/
- chore/
- fix/

Anything outside this would lead to closing of the PR and redoing it.

## Backend

- Link: https://kally-dish-recipe.onrender.com/