vervis/README.md

# Vervis

**Vervis** is a project hosting and management application, with a focus on
softare projects and decentralization. It's still in very early development. At
the time of writing, it is a minimal web application in which you can create
Git repositories and watch their commit logs.

Vervis is free software, and is committed to software freedom and to freedom in
general. It is released to the public domain using the CC0 Public Domain
Dedication. For the boring "legal" details, see the file `COPYING`. Please use
and reuse Vervis for a Good purpose, and share your work too in the same
spirit.

## Features

This is a list of initial features I plan to support in Vervis. It helps me get
an overview of more-or-less what's left to do before the first release.

    [ ] - To do
    [~] - Work in progress
    [/] - Initial coding done, needs tests and polishing
    [x] - Complete

    [ ] User management
      [~] View your personal overview
      [~] Other users' pages
      [/] Register
      [ ] Delete account
      [/] Log in
      [/] Log out
      [ ] Reset password
      [ ] TLS client cert
        [ ] Upload it
        [ ] View it
        [ ] Log in using it
      [ ] Change profile details
      [/] Key management
        [/] Add key
        [/] Delete key
        [/] View keys
    [ ] Project management
      [/] Tickets
      [ ] Wiki
      [ ] Kanban
      [ ] Merge requests
    [ ] Repo management
      [ ] Delete repo
      [/] Add repo
      [ ] Rename repo
      [ ] Edit repo settings
      [ ] View repo content
        [/] File tree
        [ ] File content
          [/] Plain text
          [/] Syntax highlighting
          [/] Document rendering
          [ ] Images
          [ ] Audio
          [ ] Video
          [ ] Raw file download
    [ ] Darcs
      [ ] Create new repo
        [/] Web
        [ ] SSH
      [ ] Delete repo
        [/] Web
        [ ] SSH
      [/] Clone
        [/] HTTP
        [/] SSH
      [/] Pull
        [/] HTTP
        [/] SSH
      [ ] Push
        [ ] HTTP
        [/] SSH
      [/] View
        [/] History
        [/] Files
    [ ] Git
      [ ] Create new repo
        [/] Web
        [ ] SSH
      [ ] Delete repo
        [/] Web
        [ ] SSH
      [ ] Clone
        [ ] HTTP
        [/] SSH
        [ ] Git
      [ ] Pull
        [ ] HTTP
        [/] SSH
        [ ] Git
      [ ] Push
        [ ] HTTP
        [/] SSH
      [/] View
        [/] History
        [/] Files
    [ ] Federation

## Installation

See `INSTALL.md`. To be honest, I haven't written it yet. Just use `stack
install`, pray, and ask me if anything fails. Ah, actually before that you need
to create a PostgreSQL database, generate an SSH key and update the settings in
`config/settings.yml` as needed. I promise to write detailed instructions soon.

## Using

See the .cabal file for more info and link to project website and version
control.

The official download location is the Darcs repository:

<http://hub.darcs.net/fr33domlover/vervis>

Releases are made to Hackage, the Haskell package repository.
See <http://hackage.haskell.org/package/vervis>.

See the file `INSTALL.md` for a detailed usage and deployment guide. The file
`ChangeLog` explains how to see the history log of the changes done in the
code. `NEWS.md` provides a friendly overview of the changes for each release.

## Reporting Bugs and Suggesting Features

If you found a bug, or you have an idea, a feature request or a wishlist item,
open a ticket for it! Even if you're goint to implement something or try to
solve it.

<http://rel4tion.org/projects/vervis/tickets/>

If you're going to implement some feature or fix some bug you found,
**start by opening a ticket** so that other people will know which features are
being developed and who does what.