Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drex44/good-food-guide
A guide to know which foods are good when you have certain disease! [Built with React/NextJs]
https://github.com/drex44/good-food-guide
css hacktoberfest html javascript material-ui nextjs reactjs
Last synced: 2 months ago
JSON representation
A guide to know which foods are good when you have certain disease! [Built with React/NextJs]
- Host: GitHub
- URL: https://github.com/drex44/good-food-guide
- Owner: drex44
- License: mit
- Created: 2018-10-08T11:26:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-21T12:14:13.000Z (over 2 years ago)
- Last Synced: 2024-01-16T16:49:48.458Z (12 months ago)
- Topics: css, hacktoberfest, html, javascript, material-ui, nextjs, reactjs
- Language: JavaScript
- Homepage: https://good-food-guide.now.sh
- Size: 2.19 MB
- Stars: 48
- Watchers: 5
- Forks: 38
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Good Food Guide :tada::tada::smile:
[](https://greenkeeper.io/)
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](https://medium.com/free-code-camp/how-i-went-from-being-a-contributor-to-an-open-source-project-maintainer-acd8a6b316f5)
It started when the Hacktoberfest '18 was announced with the vision to make a productive [Hacktoberfest](https://hacktoberfest.digitalocean.com/).
If you like this repo then show your support,
:star: 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](https://trunkbaseddevelopment.com/monorepos/) 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](https://github.com/drex44/good-food-guide/blob/master/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:
```bash
$ cd good-food-guide/www
```
3. Install all dependencies:
```bash
$ yarn
# or
$ npm install
```
4. Start the dev server and edit some code!
```bash
$ yarn dev
# or
$ npm run dev
```
### Important Links :pencil2:
Here are some links for grasping the code & further procedure. May the force be with you! and Happy coding!
1. [Learn React](https://reactjs.org/docs/hello-world.html)
2. [Learn NextJs](https://nextjs.org/learn)
3. [Material UI Docs](http://material-ui.com)
4. [Learn how to make pull request](https://help.github.com/articles/creating-a-pull-request/)
5. [Learn how to fork a repository](https://help.github.com/articles/fork-a-repo/)
## License
This repository is licensed under the MIT license. See `LICENSE` for
details.