theguydangerous/foodcoders

A Frontend based open source website for your new hobby ;)

FoodCoders - An OpenSource Cookbook

This repository is a compilation of all of our contributor's favourite recipes compiled into a website. It is meant to contribute to, and share your favourite recipes, with just making tweaks to the template, and adding their own page of 6 unique dishes.
I am extremely picky about any contributions to keep this project clean and efficient.

Overview

• This repository being under Hacktoberfest accepted repositories, managed over 150 contributions from indivisual contributors.
• As of January 2024, the repository is listed under TRC's Winter of Code event as a Project partner.
• Domain shift to a more recognised one.
• Major UI haul done to the HomePage by contributor Neutx
• This repo, is purely dependent on the kind contributions we recieve.

Support

• To morally and mentally support the project, make sure to leave a ⭐️!
• Fundings are shown on the right side of the screen, if you wanna help out.

Official Video (Deprecated)

Building from Source

1. Clone the Repository:

   git clone https://github.com/TheGuyDangerous/FoodCoders.git

2. Navigate to the Project Directory:

   cd FoodCoders

3. Run LiveServer Extension

   download the live server extension from VS code's extension library

---

Issues

If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me to promptly address any bugs or consider contributing requests.

Contribute Code

To contribute new code, please ensure that it is submitted to the TEST BRANCH WITH YOUR USERNAME. Please note that merges be performed on the MAIN branch, only after reviewing your branch of the fork.

When creating pull requests, it is essential to thoroughly document all changes made. This includes documenting any additions made to the tweaks section and ensuring that corresponding undo measures are in place to remove the newly added tweaks if necessary. Failure to adhere to this format may result in denial of the pull request. Additionally, comprehensive documentation is required for all code changes. Any code lacking sufficient documentation may also be denied.

Contributions are welcome. Please read our contributing guidelines before contributing.

License

Copyright © 2021 Sannidhya Dubey

FoodCoders is a free software licensed under GPL v3.0
It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Being Open Source doesn't mean you can just make a copy of the app and upload it on a hosting site or sell
a closed source copy of the same.
Read the following carefully:
1. Any copy of a software under GPL must be under same license. So you can't upload the app on a closed source
  app repository like PlayStore/AppStore/Not of GitHub without distributing the source code.
2. You can't sell any copied/modified version of the app under any "non-free" license.
   You must provide the copy with the original software or with instructions on how to obtain original software,
   should clearly state all changes, should clearly disclose full source code, should include same license
   and all copyrights should be retained.

In simple words, You can ONLY use the source code of this app for `Open Source` Project under `GPL v3.0` or later
with all your source code CLEARLY DISCLOSED on any code hosting platform like GitHub, with clear INSTRUCTIONS on
how to obtain the original software, should clearly STATE ALL CHANGES made and should RETAIN all copyrights.
Use of this software under any "non-free" license is NOT permitted.

See the GNU General Public License for more details.

Thanks to all Contributors

Thanks a lot for spending your time helping FoodCoders grow. Thanks a lot! Keep rocking 🍻.

GitHub Stats