Skip to content

shanedonburke/PlanDot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PlanDot

Logo

PlanDot is a personal planning tool that makes keeping track of your life easier than ever before.

  • Capture assignments, tasks, events, and to-dos as items. Then, organize your items by placing them in groups.
  • Assign dates, times, and locations to your items. Or don't!
  • Sort, filter, and search to find and prioritize the things you need to do.
  • View your items as a monthy calendar, or as a daily agenda.

Technologies

  • TypeScript
  • Angular
  • Node.js
  • Express
  • Tailwind CSS
  • Jasmine
  • Jest

Running the app

Note: 2048 MB of RAM is recommended to build and run the app. Having less RAM may lead to crashes or infinite build times.

Development

Before you can run the app:

  1. Install Node.js
  2. Install the Angular CLI
  3. Install MongoDB Community Edition

After cloning the repository, to prepare the app for execution:

$ (cd frontend && npm install)
$ (cd backend && npm install)

To run the front-end in development mode:

$ cd frontend
$ npm install
$ npm run serve

To run the back-end in development mode:

$ cd backend
$ npm install
$ export NODE_ENV=dev
$ npm run serve

Production

To deploy the app on an Ubuntu server (other distributions should work too, with adjustments):

  1. Install Node.js
  2. Install the Angular CLI
  3. Install MongoDB Community Edition
$ chmod +x deploy.sh
$ ./deploy.sh

Running tests

To run back-end unit tests:

$ cd backend
$ npm run test

You can also use npm run test -- --watch to run the unit tests in watch mode.

To run front-end unit tests:

$ cd frontend
$ npm run test

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published