Personal Efficiency Helper

Table of Contents

• About
• Design Mockups
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Available Scripts
• Author
• License

About

The assistant to improve your personal efficiency on the daily basis. Current application version contains concentration keeper, playlists for productive work, personal efficiency hacks, and recommendations. ToDo planner, habits tracker, and personal statistics are planned for the future development.

• Client: Typescript+React
• Server: Express.js, PostgreSQL

Design Mockups

Current design mockups and UI palette is available in Figma.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

Download the project from GitHub

git clone https://github.com/mari1647iv/personal-efficiency-helper.git

Ensure you have a running PostgreSQL server

sudo apt update
sudo apt install postgresql postgresql-contrib postgresql-client
sudo systemctl start postgesql.service

Install the necessary dependecies using npm

cd client
npm i
cd ../server
npm i
cd..

Installation

If necessary, create user and database for the application

sudo -iu posrgres
createuser --pwprompt pefuser
createdb -O pefuser pefdb

You can access the database from pefuser shell

su - pefuser
psql pefdb

or from another OS username:

psql -d pefdb -h localhost -U pefuser -W

Create file .env in the ./server folder and put there your database credentials in the following format:

POSTGRESQL_HOST = 
POSTGRESQL_PORT = 
POSTGRESQL_USER = 
POSTGRESQL_DATABASE =  
POSTGRESQL_PASSWORD = 

Setup the database

cd server
npm run db-setup

Run this script to start the server

cd server
npm run ts-dev

Start the client application

cd client
npm start

Open http://localhost:3000 to view it in your browser.

Usage

Available Scripts

In the client directory, you can run:

npm start

Runs the app in the development mode on port 3000.

The page will reload when you make changes. You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Author

Marina Ivanova. Frontend developer from Kazan, Russia

• Github: @mari1647iv
• Email: ima1647@outlook.com
• Telegram: @mari1647iv
• CV: https://career.habr.com/mari1647iv/print.pdf

Project Link: https://github.com/mari1647iv/personal-efficiency-helper

License

Distributed under the MIT License. See LICENSE.md for more information.