Title of Project

Table of Contents

1. About The Project
   • Roadmap
2. Get Started
   • Prerequisites
   • Installation
3. Launching
4. Built With
5. Contributing
6. Versions
7. License
8. Acknowledgments
9. Authors

About the Project

Ultimate Planner is a comprehensive application designed to help you organize and plan your day-to-day tasks. With features that span from to-do list management to tracking habits, this app is built to improve productivity and daily planning. The app includes:

• To-do lists and task management, with both list and kanban views.
• Calendar management for personalized event creation, offering daily, weekly, and monthly views.
• Note creation to help you stay on top of important reminders.
• Tracker management for keeping tabs on water intake, mood, sleep, and habits.
• Dashboard view that brings together the key elements of your day, with stats from trackers and habits.

(back to top)

Roadmap

The project is currently in the development phase. The project has been initiated.

Here is the project roadmap for the moment:

• MVP (v. 1.0.0):
  • To-do list and task management (#13);
  • Management of several to-do lists (#17);
  • Kanban view (#18);
  • User management (#24);
• V1 (v. 1.1.0):
  • Menu (#30);
  • Custom management (color, pin, tags) (#29);
  • Settings (#31);
  • Management of notes (#32);
• Later:
  • Dashboard;
  • Tracker management (water, mood, sleep);
  • Habit management;
  • Event management and display;
  • Advanced settings.

(back to top)

Get Started

Follow the instructions below to get started with the Ultimate Planner project. You'll need to set up the environment and install some dependencies before running the app.

(back to top)

Prerequisites

Before proceeding with the installation, please ensure that the following software is installed on your system:

• Node.js (Version 14.x or higher). You can download Node.js from here.
• npm (Node Package Manager) or Yarn
• PostgreSQL (for the database)

For Windows:

• Git Bash (to run the database creation script). You can download Git bash from here.

(back to top)

Installation

Clone this repository:

git clone https://github.com/Lrigami/Ultimate-Planner.git

Navigate to the project directory:

cd Ultimate-Planner/backend

Install the dependencies:

npm install

Set up the database by configuring the PostgreSQL connection in .env file.

Create the database : On Linux/macOs:

chmod +x setup_db.sh
./setupdb.sh

On Windows:

Make sure that Git Bash is configured to use PostgreSQL, i.e. psql must be installed and available in the PATH of the Git Bash environment. Open Git Bash in the project directory.

./setupdb.sh

Follow the instructions in the terminal to create and import the database.

Start the development server:

npm run start

Now, the application should be running locally at http://localhost:3000.

(back to top)

Launching

To launch the project, navigate to the frontend directory :

cd Ultimate-Planner/frontend

Install the dependencies :

npm install

Then run the following command:

ng serve

This will start the project. You can access it via your browser at http://localhost:4200.

(back to top)

Built with

• Angular - Web Application Framework
• Node.js - Runtime Environment
• PostgreSQL - Relational Database Management System (RDBMS)

(back to top)

Contributing

If you'd like to contribute to the development of Ultimate Planner, please read our CONTRIBUTING.md for guidelines on how to submit a contribution.

(back to top)

Versions

Latest stable version: 1.0.0

Latest release: 1.0.0

[You can see the full list of releases here.](https://github.com/Lrigami/Ultimate-Planner/tags)

(back to top)

License

This project is under GNU AFFERO GENERAL PUBLIC license - see LICENSE file for more informations. If you need a commercial license, please contact me.

(back to top)

Acknowledgments

Angular UI - For providing a great utility-first CSS framework that helped with the UI.

(back to top)

Authors

• THIRY Prune alias @Lrigami

(back to top)