Skip to content

cqlim/Tarpaulin-RESTFUL-API-

Repository files navigation

Tarpaulin

Tarpaulin is a a lightweight course management tool that’s an “alternative” to Canvas.

  • Type some Markdown on the left
  • See HTML in the right
  • Magic

Tech

Tarpaulin uses a number of open source projects to work properly:

  • MySQL - HTML enhanced for web apps!
  • MongoDB - Database to store images with GridFS bucket
  • Redis - Rate limiting with Reddis.
  • GridFS - Store images as buckets with MongoDB
  • mySQL2 - I/O to the MYSQL backend
  • Docker - Docker container to run MongoDB, Redis, MySQL
  • Express - Express
  • Node.js - fast node.js network app framework

And of course Dillinger itself is open source with a [public repository][dill] on GitHub.

Installation

Tarpaulin requires Node.js v4+ to run.

Install the dependencies and devDependencies and start the server.

$ npm install 
### Docker
Tarpaulin is very easy to install and deploy in a Docker container.

By default, the Docker will expose port 8080, so change this within the Dockerfile if necessary. When ready, simply use the Dockerfile to build the image.
docker-compose up 

Verify the deployment by navigating to your server address in your preferred browser.

localhost:8000

Documentation

See Requirement Document see Architecture Diagram

Todos

  • Completed

License

MIT

Free Software, Hell Yeah!

About

Tarpaulin is a lightweight course management tool that’s an “alternative” to Canvas. In particular, Tarpaulin allows users (instructors and students) to see information about the courses they’re teaching/taking. It allows instructors to create assignments for their courses, and it allows students to submit solutions to those assignments.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors