The bulletjournal from huang12zheng

huang12zheng / bulletjournal Goto Github PK

View Code? Open in Web Editor NEW

An organizational system that helps you keep track of everything in your busy life

License: GNU General Public License v2.0

Dockerfile 0.18% Java 43.89% Shell 0.20% HTML 2.49% CSS 1.78% Makefile 0.05% Go 3.75% TypeScript 39.93% JavaScript 4.60% Batchfile 0.01% PLpgSQL 0.15% SCSS 1.02% Less 1.64% FreeMarker 0.32%

bulletjournal's Introduction

BulletJournal is an open source platform for notebook keeping, ledger management, task/project management and coordination with speciality in personal organization, scheduling, reminders, to-do lists, notes sharing, multi-person ledger and team project collaboration.

You can join Slack Group for discussion.

Installation

Docker

Pre-requisite (Docker)

Docker 19.03.5+
Postgres 9.4+
Docker Compose 1.25+ (optional but recommended)

Quick Start

Please open the terminal and execute the command below. Make sure you have installed docker-compose in advance.

git clone https://github.com/singerdmx/BulletJournal.git
cd BulletJournal
chmod +x buildImage.sh
chmod +x start.sh

Next, you can look into the docker-compose.yml for detailed config parameters. Then execute the command below to start the services.

./buildImage.sh
./start.sh

Open the browser and enter https://localhost to see the UI interface. Open the browser and enter http://localhost:8080/swagger-ui.html to see the API documentation.

bulletjournal's People