Tar Heel Calendar

Tar Heel Calendar is our final project for COMP 426: Modern Web Programming. It is under development.

Installation

In order to run this project locally, you must have the following software installed:

1. NodeJS and NPM. These will handle our JavaScript dependencies.
2. MariaDB. (Theoretically MySQL might work too but let's not be soulless here.)

HeidiSQL is also recommended for viewing the MariaDB database directly. It can be installed alongside MariaDB.

The database then needs to be set up. Run the following in the command line to do this:

1. npm run create-database
2. npm run create-tables

These processes will kinda just keep going even after they are done, so count to five and then force quit the process.

Starting

1. Have the MariaDB server running. In order to log in/connect, JawsDB will interject their information if on the Heroku server, OR the calendar will use environmental variables for credentials (DBHOST, DBUSER, DBPASSWORD), or if those don't exist, defaults will be used ('localhost', 'root', 'password').
2. Run npm run start. This will first build and then start the server.
3. Now the app has started! Note you must manually connect to your local host, Node.js will not open this up automatically for you.

If you're only working on one end of the project, this may be a bit slow. There are a few other commands you can use if you feel this is the case:

1. npm run start-client will run only the frontend. Note that, obviously, the frontend may not work very well without the backend.
2. npm run start-server will run the backend without attempting to build the frontend. If your frontend is already built, this is fine, but any changes to the frontend must be rebuilt manually.
3. npm run build will build the frontend.
4. npm run test will run frontend unit tests.
5. npm run drop-tables will drop all tables in the database (if they exist).
6. npm run create-sample-data will insert some sample data into the database for testing purposes.

API documentation

The backend API is fully documented here.

Technologies used

• Node.js
• React (with Create React App)
• Bulma
• axios
• express
• mysql (the npm package)
• MariaDB
• Heroku
• JawsDB

Other technologies used are listed in package.json.

Authors

• Victoria Hoffmann
• Alfred Mathew
• Eric Schneider
• Ezri White

Live website

The live website is currently located at tar-heel-calendar.herokuapp.com. Note it is not stable nor 100% secure, so use with caution. The live website will restart with each upstream Git commit.