Skip to content
This repository has been archived by the owner on Jul 29, 2022. It is now read-only.

mdeous/WaikUp

Repository files navigation

WaikUp

Collaborative news sharing platform.

Introduction

WaikUp is an application for teams who want a collaborative platform to share their findings around the Web.

Additionally to the traditionnal web interface, WaikUp provides a RESTful API that allows other interfaces (browser extension, mobile application, etc...) to be built upon it.

Development status

  • Web UI: OK
  • Users management: OK
  • API: OK
  • API Documentation: OK
  • Database migration: TODO
  • Deployment documentation: OK

Management utility

All the application's management is done using the waikup_manage utility (installed in your $PATH by the setup.py).

To be more documented... Meanwhile, use --help to know more about available commands

API

A dedicated documentation page is available here.

Deployment

A dedicated documentation page is available here.

Issues and contributions

If you encounter any bug, or think a particular feature is missing, feel free to open a ticket, or even better, fork the repository and make a pull request with your changes! ;)

Version control workflow

Development of this application and its features (try to) follow the git-flow workflow, to ensure features' code is separated from the stable (master) branch, and stable code remains, well... stable!

The complete workflow is explained in details on this page, and the git-flow utility can be found here.

Licensing

This project is licensed under the GNU General Public License v3.