alexdeathway / k9archiver

A self-hosted journal and article archiver with a gallery feature built on top of Django, that enables collaboration and note-taking.

Home Page:https://k9archiver.alexdeathway.me

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

k9archiver

logo

Django Project Test Build coverage issues


What it isn't ?

This isn't bookmark helper or presentation maker. Tweaking might help it to act one.

What it is ?

This is a self-hosted website that can be used to Log/Note/journal almost anything by an individual or community.

Resources


Screenshots

Home Page Section K9archiver Screenshot

Note Page Section K9archiver Screenshot

Cluster Page Section K9archiver Screenshot


Quick development Guide

⚠️ Data used for/in dummy media/database isn't owned or licensed under this project and is here for sole purpose of setting up quick development and testing environment, do not publish or distribute.

Using Docker

  1. Create .env file
mv template.env .env
  1. Start development docker
sudo docker-compose -f docker-compose.yml up --build

Using virtualenv

  1. Create .env file
mv template.env .env
  1. Create virtual environment
virtualenv <environment name>
  1. Install required packages
pip install -r requirements.txt
  1. Run migrations and Load dummy data to database
python manage.py migrate
python manage.py loaddata db.json
  1. Read project overview for app & structure understanding.

  2. Choose issue or work on own feature.


About

A self-hosted journal and article archiver with a gallery feature built on top of Django, that enables collaboration and note-taking.

https://k9archiver.alexdeathway.me


Languages

Language:Python 41.9%Language:HTML 36.0%Language:CSS 19.2%Language:Shell 2.2%Language:Dockerfile 0.6%Language:JavaScript 0.3%