CLAW - v0.2.1

A platform for students to stay organized and work together! Currently, CLAW has a fully functional checklist, an assignment tracker in development, and many more features including Team Projects on the way in the future!

UPDATE NOTICE!!! Follow the instructions here to update from v0.1.1 to v0.2.1. If you do not follow these instructions before updating, your CLAW installation will break.

Official host: https://claw.kittentech.org

If the official host is inaccessible please wait at least 20 minutes before making a bug report. The server automatically restarts after 15 minutes of network failures which generally fixes most connection issues.

Known issues: read here

Setup:

This guide has detailed setup instructions. Below is a quick overview.

1. Install MySQL server (https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/)
2. Run CREATE DATABASE claw;USE claw;CREATE TABLE accounts (email text, password text, name text, info json);SET GLOBAL wait_timeout = 2; in the MySQL console
3. Create the "claw_user" account using CREATE USER 'claw_user'@'localhost' IDENTIFIED BY 'claw_password';GRANT ALL PRIVILEGES ON claw.* TO 'claw_user'@'localhost';FLUSH PRIVILEGES; NOTE: You should change 'claw_password' to a more secure password. This is just an example.
4. Download the repository and run npm install
5. Follow the instructions below to create a .env file
6. Start server with node index.js
7. Go to localhost:9876 and you're all set!

.env File Creation Instructions:

1. Create a file called .env in the root CLAW directory
2. Five fields are required - MYSQL_DB_USER, MYSQL_DB_PASSWORD, MYSQL_DB_HOST, MYSQL_DB_NAME, and SERVICE_AVAILABILITY
3. The four MySQL fields are strings, but the Service Availability field is a stringified JSON!
4. Here is an example of a fully completed .env:

MYSQL_DB_USER=claw_user
MYSQL_DB_PASSWORD=claw_password
MYSQL_DB_HOST=localhost
MYSQL_DB_NAME=claw
SERVICE_AVAILABILITY={"checklist":{"available":true},"account":{"available":true}}

---

WARNING: If you host CLAW using a program such as apache, you may have to add to your VirtualHost configuration to allow encoded slashes in URLs (Example fix: `AllowEncodedSlashes NoDecode`). CLAW's authorization API WILL NOT WORK and will return 404 errors without these changes.