Skip to content

ankhzet/Ankh

Repository files navigation

Ankh

============

Ankh is a service for SAMLIB updates tracking/versioning with public API.

Installation

Technical requirements

  • Any webserver, that meets Laravel 5 requirements

Installation Instructions

  • Clone this repo
  • Pull app dependencies via composer:
machine:~/ user$ cd ankh/
machine:ankh user$ composer install
machine:ankh user$ chmod -R a+rw storage
machine:ankh user$ chmod -R a+rw bootstrap/cache
  • Configure database (you can do that while dependencies are downloading):
machine:ankh user$ sudo mysql
mysql> CREATE USER 'ankh'@'localhost' IDENTIFIED BY 'ankh';
mysql> SET PASSWORD FOR 'ankh'@'localhost' = PASSWORD('secret');
mysql> CREATE DATABASE ankh_db;
mysql> GRANT ALL PRIVILEGES ON ankh_db . * TO 'ankh'@'localhost';
mysql> FLUSH PRIVILEGES;

Note: If yours database/user preferences differs, don't forget to make changes in .env file.

  • Create all required database tables and seed them with data with artisan:
machine:ankh user$ php artisan migrate --seed
  • Now you can open website in browser and login as ankhzet@gmail.com, password password

Note: You can change database/seeds/UsersTableSeeder.php to seed database with yours credentials.

Implementation progress

  • Users/Roles

  • Author entity

    • Author entity admin-UI
    • Authors listing page
    • Author info page
    • Author submit page
    • Author edit page
    • Author-related updates page
  • Group entity

    • Group entity admin-UI
    • Groups listing page
      • Author-groups listing page
    • Group info page
    • Group edit page
    • Group-related updates page
  • Page entity

    • Page entity admin-UI
    • Pages listing page
      • Author-pages listing page
      • Group-pages listing page
    • Page info page
    • Page edit page
    • Page-related updates page
    • Page versions page
      • Page version view
      • Page version diff
      • Page version download
        • Page version download page
    • Pages collection
      • Pages collection admin-UI
      • Pages collection page
      • Pages collection API
  • Update entity

    • Update entity admin-UI
    • Updates page
    • Updates RSS
  • Update watcher

  • Updates checker

    • Load balancer
    • Cron command
      • Cron command admin-UI
  • REST'ful service API

    • Author API
    • Group API
    • Page API
    • Pages collection API
    • Update API
    • Update watch API

Change notes

  • 0.0 Initial commit
  • 0.1 Common entity types implementation
  • 0.2 Basic UI
  • 0.3 Basic Updates functionality implementation
  • 0.4 Added RSS feeds
  • 0.5 Basic forms
  • 0.6 Updates handling, views & formatting
  • 0.7 Synk subsystem implementation
  • 0.8 Added downloading functionality
  • 0.9 Added page versioning and diff view

About

SAMLIB updates tracking and versioning service

Resources

Stars

Watchers

Forks

Packages

No packages published