repo_name

project_description
Preview
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgments

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: repo_name, project_title, project_description

(back to top)

Built With

This app uses the following Python packages

• python-dotenv, to store sensitive information
• requests-oauthlib, to integrate with third-party OAuth2 providers, such as Wrike.
• requests, to send HTTP GET and POST requests
• django-environ, to manage django settings flawlessly
• djangorestframework for web browsable api.
• drf-spectacular for Sane and flexible OpenAPI 3 schema generation for Django REST framework.
• django-debug-toolbar a configurable set of panels that display various debug information about the current request/response and when clicked, display more details about the panel's content.

(back to top)

Getting Started

Prerequisites

• Optional:
  • Dokcer and Docker dependencies installed if using dokcer based setup.
  • Use ruby installer if using pre-commit hook : Search and Replace

Installation

1. Clone the repository

    $ git clone https://github.iu.edu/kikarand/Team-26-Wellness-Tracking-System

2. For local development, see the following:

(back to top)

Usage

• Setup docker containers using:

  docker build .
  docker compose -f local.yml build
  docker compose -f local.yml up
  docker compose -f local.yml down

For more examples, please refer to the Documentation built using Sphinx

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

(back to top)