Skip to content

QuacksALotLabs/sfsp-project

Repository files navigation

Banner

Python Django DOCKER CodeFactor GitHub Actions Workflow Status

Simple file sharing project

just a simple playground to get into the django framework


Getting started · Get on developing · Dokumentation


This will be my take on the python framework django. Where I try out things to get in to the guts of it and have a basic under standing of the framework.

This project makes use of conventional commits like the angular project uses them and describes them in their commit message guidlines.

The idea is to have a simple file sharing service which saves all uploads to a s3 bucket and tag uploads to make them unique. It will use hsmw session for authentication and be available as a docker container for arm and x86 plattforms.


🛫 Getting started

Docker run setup

Docker compose setup

⌨️ Get on developing

dev container

local development

  1. install python 3.13 winget install python.python313
  2. clone the repo git clone git@github.com:QuacksALotLabs/sfsp-project.git
  3. created virtual environemnt python -m venv .venv and activated it .\.venv\Scripts\activate
  4. updated package manager python.exe -m pip install --upgrade pip
  5. install requirements python -m pip install -r requirements.txt
  6. get on coding 👌

🧳 Features

  • 🧑‍🎓 hsmw session auth
    • 🔐 jwt sessions (optinal)
  • 💾 s3 bucket upload
    • 🪧 upload tagging
  • 📦 containerization
    • arm support
    • x86 support
    • github action cicd automation

Banner image source www.freepik.com

About

A simple filesharing backend made with django for learning the framework

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published