OKRE

OKRE is a Django-based web application designed to facilitate the management of OKRs (Objectives and Key Results) within organizations. It provides a user-friendly interface for setting, tracking, and achieving goals collaboratively.

---

Key Features

• Manage OKRs at organization and team level
• Set and track objectives and key results
• Handle multiple organizations

Documentation

• Quick Start Guide (to be added)
• Contributing Guide (to be added)

---

Tech Stack

• Backend: Django
• Frontend: Django templates + DaisyUI (Tailwind CSS)
• Database: SQLite

---

Getting Started

Requirements

• Python 3.10 or higher
• Node 20 or higher (used by Django-Tailwind)

Installation

1. Clone the repository:

   git clone git@github.com:Nabellaleen/okre-app.git
   cd okre-app

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

   pip install -r requirements.txt

4. Apply migrations:

   python manage.py migrate

Development

Run the app locally

To run the development server and start using OKRE, you need to run both the Django server and the Tailwind CSS build process.

• Start the Django server:

  python manage.py runserver

• Start the Tailwind CSS build process:

  python manage.py tailwind start

Then open http://localhost:8000 in your web browser.

Create a superuser

To create a superuser account for accessing the Django admin interface, run the following command:

python manage.py createsuperuser

---

License

This project is licensed under the GNU AGPL v3. See the LICENSE file for details.

Contributing

We welcome contributions to OKRE! If you have suggestions, bug reports, or feature requests, please open an issue or submit a pull request.