https://github.com/dominiquenix/task-manager
This is a task manager app that implements security features
https://github.com/dominiquenix/task-manager
auth0 bootstrap5 express handlebars mongodb mongoose nodejs rest-api
Last synced: 26 days ago
JSON representation
This is a task manager app that implements security features
- Host: GitHub
- URL: https://github.com/dominiquenix/task-manager
- Owner: DominiqueNix
- License: mit
- Created: 2024-02-02T15:56:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-14T18:03:03.000Z (11 months ago)
- Last Synced: 2025-04-09T05:44:52.715Z (26 days ago)
- Topics: auth0, bootstrap5, express, handlebars, mongodb, mongoose, nodejs, rest-api
- Language: JavaScript
- Homepage:
- Size: 433 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#api-documentation)
- [Deployed Website](#deployed-website)
- [User Story](#user-story)
- [Installation](#installation)
- [Docker](#docker)
- [Testing](#testing)
- [Website Screenshots](#website-screenshots)
- [Development](#development)
- [Technology Used](#technology-used)
- [Acknowledgements](#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](https://www.mongodb.com/) and follow the instructions for setting up a database for the MONGODB_URL
For the rest of the environment variable Navigate to [Auth0](https://auth0.com/) and follow the instructions for setting up a nodejs web application.
Once the environment variables are defined, from the root project directory run:
``` javascript
// 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:
``` javascript
// 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:
``` javascript
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
