Skip to content

eliherm/Checklist

Repository files navigation

Checklist

GitHub version

A dockerized checklist application with an authentication system. The backend is a REST API and sessions are established using cookies.

Getting Started

Instructions to setup a local copy of the project.

Prerequisites

Installation and Setup

Create a .env file in the root directory

NODE_ENV=development
PORT=3000
DB_HOST=127.0.0.1
DB_NAME=checklist
DB_USER=root
DB_PASSWORD=secret
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
SESSION_SECRET=secret

Start up the application

$ docker-compose up

Create a local copy of the SQL tables using the knex migrate feaure

$ npx knex migrate:latest

Built With

  • Docker - Containerization of the application
  • Express - Web framework for NodeJS
  • KnexJS - SQL query builder
  • Bcrypt - Hashing and salting of passwords
  • Passport - Authentication middleware for express
  • Express validator - Validation and sanitization
  • EJS - Javascript templating for the client

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

About

Simple checklist application

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published