https://github.com/moojigc/projectkanri

A project management application, built on a ReactJS front-end and an ExpressJS/Mongoose back-end. You can manage your project kanban-board style, as well as invite other users on the site to join your team.
https://github.com/moojigc/projectkanri

expressjs mongodb nodejs react

Last synced: about 1 month ago
JSON representation

A project management application, built on a ReactJS front-end and an ExpressJS/Mongoose back-end. You can manage your project kanban-board style, as well as invite other users on the site to join your team.

• Host: GitHub
• URL: https://github.com/moojigc/projectkanri
• Owner: moojigc
• Created: 2020-06-27T18:02:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T20:13:14.000Z (almost 2 years ago)
• Last Synced: 2023-05-06T01:23:50.708Z (over 1 year ago)
• Topics: expressjs, mongodb, nodejs, react
• Language: JavaScript
• Homepage: https://projectkanri.chimid.rocks/
• Size: 2.29 MB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ProjectKanri

> Developed by Moojig Chimid, [Samantha Taddonio](https://github.com/stadds), and [Mahfuza Pia Rahman](https://github.com/mpiarahman16).



## Description

*ProjectKanri* is a a project management web application, similar in concept to GitHub's Projects page. As a user, you can create a new project and populate it with subprojects or *tasks* as we call them. You can keep track of the status of those tasks, whether they're still to-do, in progress, in review, or completed. You can also, using email, invite other users to join your project and assign them to particular tasks. And you don't have to worry about bad actors wreaking havoc on your project - you can set different permissions for users (admin or regular) so they can only edit tasks they're assigned to or have created.

## Tools

**On the back end**: Built on `Node.js`, `Express.js`, `Passport.js` for user authentication, `Mongoose` to manage our MongoDB database, and `Nodemailer` to send emails using Gmail. **On the front end**: Built on `React.js` using `create-react-app`, and `Material UI` as the UI framework, with some minor custom `SCSS`. 

## Running locally with Docker/Docker Compose!

This project includes a `docker-compose.yml` file for easily getting a local environment up and running.

You do need to have the following environment variables available to the compose.yml: `MAIL_USER`, `MAIL_PASS`, and `MAIL_HOST`.

Then you can run `docker compose up --build` which will always rebuild the images first.

For example...

```bash

export MAIL_USER=yourmailusername

export MAIL_PASS=yourmailpassword

export MAIL_HOST=smtp.gmail.com

docker compose up --build

```

## Try it out

Head over to [ProjectKanri](https://projectkanri.chimid.rocks) today to sign up for an account and start tracking your next project's progress!.

## The Team

**Moojig**: All aspects of user authentication on back and front end, including setting up Express middleware to track user sessions. Created the schema for the Mongoose database models, optimizing our API endpoints and adding in checks for admin/non-admin users on PUT and DELETE routes for projects/tasks. Created some pages on the front end: `Welcome` page, `Profile` page, `Login` page, and `Comments` component for the `Task` page.

**Samantha**: `/api/projects` endpoints, creating the `Dashboard` and `Project` pages, and creating the front end API interactions for the `Project` and `Dashboard` pages.

**Pia**: Creating the `Task` page, set up front end API interactions for `tasks` and setting up back end `/api/tasks` endpoints.