/Kanban

This is an App where a user can manage his/her activities, schedules, or task.

Primary LanguageTypeScript

Kanban

This is an App where a user can manage his/her activities, schedules, or task.

Tech Stack: MongoDB, Express.js, React.js, Node.js, Typescript

Contributors: Uche , Ankit Babber , Peter Logo , Antwi

Built With:

Frontend

  • React/Typescript - The framework used for developing the components and UI.
  • Material UI - Javascript framework for styling and CSS compartmentalization.

Backend

Features:

  • Login/sign up flow with e-mail address
  • Create boards
  • Create columns
  • Create cards in columns
  • Add descriptions in cards (e.g. deadlines, descriptions, comments, attachments, etc.)
  • Drag cards to different columns
  • Archive cards once completed
  • Convert kanban board into a calendar view

Installation:

If you want to run the application locally, follow the instructions below:

  1. Clone repository
  2. Install Dependencies - Run npm install in the root directory and client directory
  3. Create a file with the name .env
  4. Add the application secret key for authentication using SECRET_KEY to .env
  5. Add the application mongo uri MONGO_LOCAL_URI to .env. Additional information to run mongoDB locally can be found here. Alternatively you can use Mongo Atlas here.
  6. To run code from the code editor, create an account on Cloudinary. You can find your api key after registering here. Add cloudinary keys CLOUDINARY_NAME, CLOUDINARY_API_KEY and CLOUDINARY_API_SECRET to .env.
  7. Sign up for AWS S3 and add S3_ACCESS_KEY, S3_ACCESS_SECRET and S3_BUCKET_NAME to .env
  8. Final .env appear should like below:
JWT_SECRET=<Secret key for JWT >
MONGO_LOCAL_URI=<Your mongo uri>
AWS_BUCKET_NAME=<your aws bucket name>
AWS_BUCKET_REGION=<your aws bucket data base region>
AWS_BUCKET_ACCESS_KEY=<  your aws access key>
AWS_BUCKET_SECRET_ACCESS_KEY=< your aws secret access key>
CLOUDINARY_NAME=< your cloudinary account name>
CLOUDINARY_API_KEY=< your cloudinary api key>
CLOUDINARY_API_SECRET=<your cloudinary api secret key>
  1. Run npm run dev to start the server on the root directory and npm start on client to start the application

Demo

  1. Registration. Users will be able to create a new account using their email and password

Signup Demo

  1. Dashboard. Here is a description about what a user can expect to see

Dashboard