Skip to content

GuillaumeEven/failaka

Repository files navigation

🏺 Failaka Archaeological Archives

Digital archiving and public valorization of archaeological resources from the Failaka excavation site, Kuwait.

Language Framework API Status


📖 Overview

This project is a digital archive and valorization platform for the archaeological site of Failaka, located in Kuwait. It aims to centralize, preserve, and provide structured access to historical data, excavation reports, images, and metadata.

The platform consists of:

  • A backend API to manage and serve archaeological data
  • A web frontend (under construction) for researchers and the general public

🖥️ Demo

📷 Screenshot
Demo


⚙️ Installation

This is a standard Django-based backend API. To run locally:

# Clone the repository
git clone https://github.com/DaGuinci/failaka
cd failaka-archives

# (Recommended) Create and activate a virtual environment
python -m venv env
source env/bin/activate

# Install dependencies
pip install -r requirements.txt

# Set up the database (PostgreSQL)
createdb failaka
python manage.py migrate

# Create a superuser
python manage.py createsuperuser

# Run the development server
python manage.py runserver

Make sure to configure your .env file or Django settings for PostgreSQL access and JWT secret keys.


💡 Technologies Used

  • 🐍 Python
  • 🧱 Django (4.x)
  • 🔗 Django REST Framework (DRF)
  • 🔐 JWT Authentication
  • 📄 Swagger UI (via drf-spectacular)
  • 📚 Sphinx (for internal project documentation)
  • 🗄️ PostgreSQL (database)
  • 🐳 Docker (containerized development & deployment)
  • 🚀 CI/CD with GitHub Actions

👤 About the Developer

Developed by Guillaume Even

evendev logo

About

Sauvegarde et valorisation des archives de la mission Failalka

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors