Giter VIP home page Giter VIP logo

good-food-guide's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.