diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | README.md | 33 | ||||
| -rw-r--r-- | custom/.gitignore | 3 |
3 files changed, 37 insertions, 0 deletions
@@ -3,5 +3,6 @@ !custom !assignment_list* !setup.php +!README.md !.gitignore diff --git a/README.md b/README.md new file mode 100644 index 0000000..79ddba2 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Assignment List + +assignment_list is an unorthodox calendar/todo manager. It can be used to manage tasks and was originally designed as a means for managing assignments for my college classes. A MySQL database is used to manage tables and groups, and the backend is handled by PHP. + +### Requirements + +- MySQL +- PHP + +### Usage + +It is recommended for first-time users to run the `setup.php` script, which will create a `config.php` file for the backend to connect to the MySQL database and tables with the necessary columns and and constraints. + +``` +$ php setup.php +``` + +assignment_list can be self-hosted. To self-host, first start a PHP server: + +``` +$ php -S localhost:<port number> +``` + +Then navigate to `localhost:<port number>/assignment_list.html`. + +The first thing to do is to create a new "class" or group. Then, after a class has been created, assignments can be added to the class. Options for each assignment include **edit**, **clone**, **mark as done/not done**, and **delete** + +### Extending + +assignment_list supports custom CSS rules and JS scripting. The following paths will automatically be sourced by the page + +- `custom/custom.css` +- `custom/custom.js` diff --git a/custom/.gitignore b/custom/.gitignore new file mode 100644 index 0000000..94548af --- /dev/null +++ b/custom/.gitignore @@ -0,0 +1,3 @@ +* +*/ +!.gitignore |