README.md



Taskrambler

When this is finished it will become a distributed task and time
management system with a web frontend.
It will come with its own HTTP server implementation and thus wont
need any third party webserver to work.
The backend is written completely in C while the frontend will be
JavaScript, CSS and HTML.

When this is finished users will be able to connect to the server
via their browsers, manage their tasks there and specify policies
who else might see their tasks, track the time spend on a specific
task, attach tasks to projects, getting reports about their work done,
etc.

Right now for the taskmanagement stuff I think of a similar approach
as taskwarrior is going.
This is an amazing tool and I really enjoy using it.
I started this as an experiment to implement an HTTP server, then I learned
about taskwarrior and thought, wouldn't it be great to have this
functionality in a multiuser environment.

Right now, it is a single process HTTP server implementation that performs
not to bad.

In the next version user will be able to create tasks and share them at
least on a basic level.

The main development page can be found 
here.


INSTALLATION

This can be installed via the usual configure, make, make install
cycle.


API DOC

To generate the api doc a patched version of doxygen is
neccessary. A patch is included under docs.

make docs creates the api doc.


TEST COVERAGE REPORT

gcov and lcov are needed to build these.

make coverage-html creates the converage reports.


PLAY AROUND

Any asset under assets could be exchanged. It should be possible to
change the main.html there and put additionally html files and images
under assets and everything should be deliverd.

Anyway, there are a few rules.


html assets will always be loaded from assets/html.
all other assets are loaded directly from the assets directory.


So, right now this can be used as a HTTP server for static content
and without virtual hosts support.


USAGE


RUNNING

Simply start the executable src/taskrambler after successfull build.
Currently this will stay in the foreground and does logging via syslog.


PORT

The server will listen on port 11212 for HTTP requests and on port 11213
for SSL requerst.

You can use telnet or simply start a browser and connect on localhost:11212.

This should show up a very simplistic page.
It should eneable you to start a session, get values from the server
or login.


LOGIN

You can't use the login without changing the code. It's implemented using
ldap and currently not configurable. You have to change the configuration
in the code and compile again.


TESTING

This comes with an incomplete unit test suite.
You can use make test to build and run the existent tests.


REQUIREMENTS

Currently, you need valgrind to build the tests, because some memory checking is done by the way.


CONTRIBUTION

I would really like to see some people possibly interested in this stuff.
I think it contains some really interesting ideas.

Well, sadly i have to say that this is a spare time project. Documentation
is sparse and Tests too.

If you like to contribute anyway, make a fork, do your changes and generate
a pull request.

I will look at these as soon as possible.