Harmonious

Description

This is a full stack task management website built with security features using auth0, node.js, express, mongodb, mongoose, and handlebars.

Table of Contents

• Api Documentation
• Deployed Website
• User Story
• Installation
• Docker
• Testing
• Website Screenshots
• Development
• Technology Used
• Acknowledgements

Api Documentation

https://documenter.getpostman.com/view/33125592/2sA2rFRL3L

Deployed Website

https://harmonius.onrender.com/

User Story

As a user, I want to:

  1. Create an account using a third party provider
  2. View my current tasks and projects
  3. Add, update, and delete projects
  4. Add, update, and delete tasks
  5. View stats about my projects
  6. View stats about my tasks

Installation

Navigate to the .env.example file. Remove the .example extention from the file name. In this file you will find environment vaiables that need to be defined for this application to work.

Navigate to MongoDB and follow the instructions for setting up a database for the MONGODB_URL

For the rest of the environment variable Navigate to Auth0 and follow the instructions for setting up a nodejs web application.

Once the environment variables are defined, from the root project directory run:

    // install necesarry dependencies
    npm install

    // run the program
    npm run dev

If you navigate to the /seed directory, there is data that you can use to add projects and tasks

Docker

This app has an associated Dockerfile attached. The image itself is not on Dockerhub, but you an still build an image and run it locally, to do so follow these steps:

  1. Install Docker
  2. In the root project directory run the follwing commands in the terminal: 

     // Build the image
     docker build . -t harmonious
     
     // Run the program
     docker run -p 4000:4000 harmonious

Testing

Run the following from the root diectory to run the tests:

npm run test

Note: There will be a handlebars error that can be ignored. Wait a few seconds and the tests should pass despite these errors.

Website Screenshots

Landing Page

Dashboard

Project View

Task View

Development

Wireframes

Technology Used

Acknowledgements