Revoliutionizing and Automating Restaurants Menus and Workflows.🚀

Branches

• staging -> Pull requests this branch for everything
• prod -> don't touch, this is what's running in prod

Quick Start

• Clone the repo

  git clone https://github.com/FlixMenu/FlixMenu-web.git

• Fork the repo.

• Move into the root downloaded directory.

  C:/user/john/desktop> cd FlixMenu-web

  # and run 

  npm install or yarn

• Make some changes. But before making any changes, run git fetch or git pull and see if thew main branch commit is ahead of yours, this would tell if an update has been made to the repo.

• Create a separate branch

  git branch myDummyBranch

• Move into that branch

  git checkout myDummyBranch

• Check if youre actually in the branch which you created

  git branch

• Stage all changes

  git add .

• Commit all changes

  git commit -m "explain exactly what you did"

• Push all changes to that branch

  git push -u origin myDummyBranch

• Make a PR, with brief description

• Wait untill It merged ( That only if it doesnt have any conflict with the main branch )

Contributing.

To get started contributing , Please go through Contributing.md carefully.

Available tasks / features to be implemented

FlixMenu contain vast varieties of functionalities waiting to be implemented. Visit Priorities Lists and see all features and also guidelines to adhere to.

License

FlixMenu follows and adhere to the The MIT License (MIT).