/good-food-guide

A guide to know which foods are good when you have certain disease! [Built in React/NextJs]

Primary LanguageJavaScriptMIT LicenseMIT

Good Food Guide 🎉🎉😄

A guide to know which foods are good when you are suffering from a certain disease!

Hacktoberfest '18

We are celebrating Hacktoberfest 2018!

Let's have a productive Hacktoberfest. Submit 5 PRs to this repo after registering yourself here.

The idea is to create a website, about Foods to eat when you're unwell. This repository is open to all forms of suggestions. so wear your thinking hat and let the hacking begin.

Happy contributing!

If you like this repo then show your support,

⭐ this repo

How it works 🏗️

✅ Check for open issues

✅ Fork the repo

✅ Make some edits on your own copy that fixes the issues.

✅ Create a new branch and then commit.

✅ Create a pull request that will be merged to the main repo. (Remember to indicate what issue you're fixing)

✅You can check your progress here after every merged PR* : https://hacktoberfest.digitalocean.com/stats

✅Your code will be reviewed and approved.

✅If you have questions on any issue, kindly use the comment.

Don't forget to comment on the issue, you're working on. otherwise there will be two PRs for the same issue!

Don't forget to add your name to Contributors.md(AN EASY PR, Remember to contribute to the repo then raise this PR)

Important Links ✏️

Here are some links for grasping the code & further procedure. May the force be with you! and Happy coding!

  1. Learn React
  2. Learn NextJs
  3. Material UI Docs
  4. Learn how to make pull request
  5. Learn how to fork a repository

Quick Start

  1. Clone the project

  2. Navigate to your new project:

$ cd good-food-guide
  1. Install all dependencies:
$ yarn
# or
$ npm install
  1. Start the dev server and edit some code!
$ yarn dev 
# or
$ npm run dev

Contributing

check out the Contributing.md

The website will be auto deployed from the master branch so if your pull request is merged, you can check it out here!

https://good-food-guide.netlify.com

License

This repository is licensed under the MIT license. See LICENSE for details.