Code Monkey home page Code Monkey logo

swarupe7 / medplant Goto Github PK

View Code? Open in Web Editor NEW
13.0 2.0 31.0 3.43 MB

MedPlant: Open-source project using HTML, CSS, and Bootstrap to create awareness about medicinal plants. Beginner-friendly for contributions

Home Page: https://swarupe7.github.io/MedPlant/home.html

License: MIT License

HTML 96.81% CSS 3.19%
beginner beginner-friendly community-project contribution good-first-issue help-wanted html-css-javascript open-source plants bootstrap5

medplant's Introduction

MedPlant

MedPlant is an open-source project focused on creating awareness of the medicinal properties of various plants.

It aims to provide a comprehensive resource for individuals interested in alternative medicine, herbal remedies, and the healing potential of plants.

If you have any kind of doubts or queries do not hesitate to contact me. Please place "๐Ÿ˜Ž๐Ÿ˜Ž๐Ÿ˜Ž" emojis in your subject of email, so that I can easily be attentive to your mail or query.

Features

  • Extensive database of plant profiles with detailed information about their medicinal properties.
  • Community-driven platform for sharing research findings, experiences, and insights related to plant-based medicine.

Getting Started

  1. Clone this repository.

  2. Run the application.

Contributing

We welcome contributions from the open-source community to improve MedPlant. To contribute, please follow these guidelines:

Code Contribution

  1. Fork the repository and create a new branch for your contribution.
  2. Ensure that your code adheres to the project's coding style and guidelines.
  3. If you're introducing new features, enhancements, or fixes, please write clean and well-documented code.
  4. Test your changes thoroughly to ensure they do not introduce any regressions.
  5. Submit a pull request with a clear description of the changes, the problem it solves, and any relevant details.Please have a look at resources on how to get a pull request.

Adding New Plant Profiles

We encourage contributors to add new plant profiles to expand the knowledge base. To maintain consistency and quality, please consider the following guidelines:

  1. Check the existing plant profiles to ensure that the plant you wish to add hasn't been covered already.
  2. Use the existing plant profiles as a reference to understand the required information and formatting.
  3. Write an informative and well-researched plant profile, including details about its medicinal properties, cultivation methods, traditional uses, and any relevant scientific research.
  4. Ensure that the information provided is accurate, reliable, and properly cited if necessary.
  5. Include relevant images or diagrams to enhance the understanding of the plant profile.
  6. Proofread the plant profile for grammar, spelling, and readability before submitting.

Issue Reporting

If you encounter any issues or have suggestions for improvements, please follow these steps:

  1. Check the existing issues to see if the problem has already been reported.
  2. If it hasn't been reported, create a new issue with a clear and descriptive title.
  3. Provide detailed steps to reproduce the issue and any relevant information about your environment.
  4. If possible, include screenshots or error messages related to the issue.
  5. Assign appropriate labels to the issue (e.g., bug, enhancement, documentation).

Documentation

Improvements to documentation are always welcome! If you find any areas that can be clarified, expanded, or corrected, please feel free to contribute. Here's how you can help:

  1. Review the existing documentation and identify areas for improvement.
  2. If you're suggesting new documentation, create a new markdown file in the appropriate directory.
  3. Make sure your documentation follows the same style and format as the existing documentation.
  4. Submit a pull request with the changes and provide a brief explanation of the updates made.

Video Resources

For a better understanding of the project, we recommend watching the following video:

This video provides insights into the how to push a change to our repo.

Branch Guidelines

To make changes to the code, please follow these guidelines:

  1. Create a new branch for your changes, preferably named after the specific feature or bug you're working on.
  2. Make your changes on the separate branch.
  3. Test your changes thoroughly.
  4. Once you're confident in your changes, submit a pull request to merge your branch into the main branch.

Authors

All the contributors for this project can include their name in the AUTHORS file.

License

MedPlant is open-source and released under the MIT License.

Contact

If you have any questions, suggestions, or feedback, please reach out to us at: [email protected].


We would like to express our gratitude to all contributors who have helped shape and improve MedPlant.

Your contributions are greatly appreciated!

medplant's People

Contributors

abuharish02 avatar annabrum avatar anubhav1206 avatar athenacats avatar guaggy avatar kbx4 avatar keshavjha2002 avatar maheshravuri avatar naresh-kushwaha avatar onkarsrivastava avatar piyushbarve98 avatar rajeevdash007 avatar rinkitejwani avatar riyashivolkar avatar securitybe4r avatar siyabonga-ngele avatar sjswarup5e7 avatar sourav7274 avatar subhadtech avatar swarupe7 avatar valisaurus avatar zyphaex avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

medplant's Issues

Using react to make the code dynamic

Instead of static webpage we should gradually putting more importance over client side rendering with React and type checked Javascript (Typescript). This would decrease the number of .html files and improve the structure

Enhance Plant Cards with Specific Plant Information(about) instead of generic sentence.

Description:
The current implementation of the MedPlant project features cards for various herbal plants, each displaying a name along with a generic sentence in the description. To provide users with more informative content, this issue proposes replacing the generic sentence with specific details about each plant such as about of the page.

Please assign this issue to me or I'll directly submit a PR. I am open to suggestions for it.

image

Improvement to navigation

As it is, the page requires visitors to use the browser-windows back-arrow to navigate back on the page and the navbar and footer is only visible on the startpage. It would be nice to have an integrated back-arrow on all pages or at least have the navbar and footer available on all pages.

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.