Skip to content

Latest commit

 

History

History
89 lines (56 loc) · 2.36 KB

README.md

File metadata and controls

89 lines (56 loc) · 2.36 KB
Raw

Good Food Guide 🎉🎉😄

Greenkeeper badge

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

Background

Free-code-camp/contributor-to-an-open-source-project-maintainer-article

It started when the Hacktoberfest '18 was announced with the vision to make a productive Hacktoberfest.

If you like this repo then show your support,

⭐ this repo

Technology Stack

Frontend

  • Framework: NextJS
  • Search: Algolia
  • Hosting: Zeit Now.

Backend

  • Environment: NodeJS
  • Framework: Zeit Micro
  • Database: MongoDB
  • Hosting: Zeit Now, mLab

For information on packages used, checkout the package.json in api and www.

Contributing

We use monorepo structure to host code. This repository is open to all forms of suggestions. so wear your thinking hat and let the hacking begin.

For more, check out the Contributing.md

Continuous Deployments

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

This CD will break now as project structure has changed a lot! https://good-food-guide.netlify.com

soon it will be changed to, https://good-food-guide.now.sh

Quick Start for contributing

  1. Clone the project

  2. Navigate to your new project:

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

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

License

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