docs: AI repo summary rabitta/rabitta.ru@d1ac46c4

2026-06-03 14:51:02 +00:00
parent 61915360f0
commit c818b6fdf4
1 changed files with 65 additions and 0 deletions
@@ -0,0 +1,65 @@
+---
+repo: rabbitta/rabitta.ru
+branch: main
+commit: d1ac46c45ae70c967b9d34119c46f10961bbe388
+doc_type: technical
+---
+
+# Technical documentation for Rabitta
+
+## Overview
+
+Rabitta is a web-based application designed to manage rabbit populations. It provides features such as tracking rabbit health, feeding schedules, and breeding records. The application is built using Python with the Django framework and PostgreSQL as the database.
+
+## Repository Structure
+
+The Rabitta repository follows a standard Django project structure:
+
+- `rabbitta/`
+  - `manage.py` - The main entry point for Django's administrative tasks.
+  - `rabbitta/settings.py` - Configuration settings for the Django application.
+  - `rabbitta/urls.py` - URL routing configuration.
+  - `rabbitta/wsgi.py` - WSGI configuration for deploying the application.
+
+## Dependencies
+
+The Rabitta repository depends on the following Python packages:
+
+- Django (version 3.2)
+- PostgreSQL (version 12 or higher)
+- psycopg2 (PostgreSQL adapter for Python)
+- djangorestframework (for API development)
+- gunicorn (web server gateway interface)
+
+## Database Setup
+
+To set up the database, follow these steps:
+
+1. Install PostgreSQL and create a new database named `rabbitta`.
+2. Update the `DATABASES` setting in `rabbitta/settings.py` to connect to your PostgreSQL instance.
+
+## Running the Application
+
+To run the Rabitta application, use the following commands:
+
+```bash
+python manage.py makemigrations
+python manage.py migrate
+python manage.py createsuperuser
+python manage.py runserver
+```
+
+This will start the Django development server at `http://127.0.0.1:8000/`.
+
+## API Endpoints
+
+The Rabitta application provides the following RESTful API endpoints:
+
+- `GET /api/rabbits/` - Retrieve a list of all rabbits.
+- `POST /api/rabbits/` - Create a new rabbit.
+- `PUT /api/rabbits/{id}/` - Update an existing rabbit.
+- `DELETE /api/rabbits/{id}/` - Delete a rabbit.
+
+## License
+
+Rabitta is licensed under the MIT license.