simplex/ReadMe.md

17 lines
540 B
Markdown
Raw Normal View History

2018-04-24 17:02:08 +00:00
# Simplex
An extremely simple task management API.
## Installation
2018-04-25 20:42:05 +00:00
**NOTE**: The install script assumes you have `sudo` access, and that the server
will be run by user `www-data`.
2018-04-24 17:02:08 +00:00
For development, simply run `./install.sh dev`. This will install necessary
prerequisites. Run `lapis server production` to start the server and `lapis term`
to stop it.
For production, make sure a domain name is pointed at the server's IP address,
then run `./install.sh`. This will install the necessary prerequisites and start
the server as a service.