rakesh-nj / glucolingo

Glucolingo - designed to help diabetic patients manage their condition.

Contributing to Glucolingo

Thank you for considering contributing to [Your Project Name]! This guide will help you understand how to get involved, report issues, and submit contributions to the project.

Table of Contents

1. How to Contribute
   • Reporting Issues
   • Suggesting Enhancements
   • Submitting Code Changes
2. Development Setup
   • Fork the Repository
   • Setting Up the Environment
   • Running Tests
3. Coding Guidelines
4. Style Guide
5. Documentation
6. Community and Support
7. License

How to Contribute

Reporting Issues

If you encounter any bugs, have questions, or have feature requests, please open an issue in our GitHub Issues. When reporting an issue, include:

• A clear and descriptive title.
• A detailed description of the problem.
• Steps to reproduce the issue, if applicable.
• Any relevant logs, screenshots, or files.

Suggesting Enhancements

We welcome suggestions for new features and improvements. Please open an issue with:

• A clear and descriptive title.
• A detailed description of the enhancement.
• Why it would be useful.
• Any potential drawbacks.

Submitting Code Changes

1. Check for Existing Issues: Look for existing issues that cover your idea. If one exists, comment on it and mention your plan to contribute.
2. Fork the Repository: Fork the repo and create a new branch for your changes.
3. Make Changes: Implement your changes, following our coding and style guidelines.
4. Write Tests: Add tests to ensure your changes work as expected.
5. Create a Pull Request: Submit a pull request with a clear description of your changes, referencing any related issues.

Contribution Guide

1. Fork and Clone the repository

• Fork the repository
• Clone the forked repo git clone <forked_repo_url>

2. Create and activate virtual environment

  cd glucolingo

  python -m venv myenv

3. Activate Virtual Environment

• Windows OS

  myenv\Scripts\activate

• Linux/mac OS

  source myenv/bin/activate

4. Install dependencies

pip install -r requirements.txt

5. Start server

python manage.py runserver

glucolingo's Issues

Add static file(css) for profile

Setup MySQL database

Create profile template

Create an html template for user's profile

create user auth

Create user auth system

Implement chainlink chat interface

enhance templates and staticfiles

Enhance staticfiles & templates

Create login & signup templates and staticfiles

Create vector embeddings, save to vector databases locally