justdoinc/justdo repository overview

⁠JustDo – Project Management & Collaboration Platform

JustDo is a powerful, source-available⁠ project management solution that helps teams of any size stay organized, collaborate effectively, and adapt to evolving needs.

Built on Meteor, MongoDB, and Node.js, JustDo delivers robust performance for everything from simple to enterprise-scale projects. Thanks to its source-available nature, you can self-host, customize, and scale the platform to match your exact requirements.

This Docker container includes 15 free user licenses for localhost usage. If you want to run JustDo on a custom domain or need more users, see our pricing page⁠ under the “You Manage” column for full details about pricing and trial periods.

Every business is unique, and no single project management tool can meet everyone’s needs. JustDo’s source-availability lets you transform complexity into a competitive advantage.

Think JustDo fits your clients’ needs? Got a market for it?
Learn how to become a JustDo distributor⁠

⁠Quick Reference

• Live Demo & More Info: JustDo Homepage⁠
• Source Code & Docker Container: JustDo's GitHub Repository⁠ Your ⭐️ on GitHub is greatly appreciated!
• Help & Updates:
  • r/justdo on Reddit⁠ – Discussions and announcements
  • GitHub Issues⁠ – Report bugs or request features

⁠🚀 Installation & Usage

The installation options are as follows:

• Option 1: Quick Start With a Convenient One-Liner⁠
  • Maintanance Operations for Option 1⁠
• Option 2: Customized Docker Compose Setup⁠
  • Maintanance Operations for Option 2⁠
• Option 3: Running Development Environment from Source Code⁠

⁠Option 1: Quick Start With a Convenient One-Liner

This is the recommended option for quickly evaluating JustDo under localhost. You can also explore a demo instance at justdo.com⁠. This setup works well for local testing. For a production-ready configuration see Option 2⁠.

You can copy and paste the following line into your shell for a quick setup:

curl -Ls https://justdo.com/docker-compose.yml | docker compose -p "justdo" -f - up -d

This will start a JustDo container and a MongoDB container.

Please allow 2–3 minutes for everything to fully initialize.

⁠Accessing JustDo:

JustDo consists of two apps:

• Landing Page (Registration/Login) at http://localhost:3150⁠
• Main Web App at http://localhost:3151⁠

Check the Maintanance Operations⁠ section for details about stopping/starting/removing the JustDo stack & information about the MongoDB container backup/restore.

⁠Option 2: Customized Docker Compose Setup

Purpose: This option offers a production-ready or fully customizable JustDo environment. Rather than using a quick one-liner, you'll download our docker-compose.yml⁠ file. We've included extensive comments and example configurations for the most common customizations, so you can adapt the setup to your specific needs.

⁠Step 1: Download and Modify docker-compose.yml

1. Download the docker-compose.yml file⁠.
2. Open it in a text editor and adjust ports, credentials, or environment variables to match your requirements.

Notes:

1. Use a Secure MongoDB Password
   Even though the MongoDB container is bound to 127.0.0.1 and not exposed externally, it's still best practice to set a strong password for the admin user.

2. Override Any Environment Variable
   All environment variables referenced in our default-config.bash⁠ are supported; simply define or override them under the environment: section of the justdo service.

3. Switching from Option 1
   If you already installed the JustDo stack with Option 1 and now want to configure the MongoDB password, you'll need to remove the existing stack first (see Maintenance Operations⁠). Doing so clears the data stored in the volumes—assuming it was for evaluation only. If you need to keep that data, back it up before switching to Option 2.

⁠Step 2: Installing the Docker Compose stack

Run the following command to start the containers in the folder in which you located the docker-compose.yml file:

docker compose -p "justdo" up -d

Note that we use -p "justdo" to specify the project name for this Docker Compose stack. This ensures container names stay consistent and predictable—so the maintenance commands⁠ below (e.g., stopping or removing containers) will function as expected.

Please allow 2–3 minutes for everything to fully initialize.

⁠Step 3: Access JustDo

If you didn't change the default ports in the docker-compose.yml file, you can access JustDo at:

• Landing Page (Registration/Login) at http://localhost:3150⁠
• Main Web App at http://localhost:3151⁠

Check the Maintanance Operations⁠ section for details about stopping/starting/removing the JustDo stack & information about the MongoDB container backup/restore.

⁠Option 3: Running Development Environment from Source Code

The source code of JustDo is available on GitHub⁠. If you prefer to run JustDo natively or want to customize the codebase, follow these steps:

⁠Step 1: Install Prerequisites

⁠Install Meteor

JustDo is built on Meteor.js⁠, a powerful full-stack JavaScript framework for building real-time applications.

Install Meteor.js by running the following command in your terminal:

curl https://install.meteor.com/\?release\=2.16 | sh

⁠macOS Additional Steps

We have minimized external dependencies as much as possible. However, on macOS, you'll need to ensure that Python 2.7 is installed, as it is required for the compilation processes of some of our packages. Additionally, you'll need to install the Xcode Command Line Tools.

1. Install Python 2.7 using Homebrew & pyenv:

Note: The following steps are optional and only required if you don't have Python 2.7 installed on your system. Further they are one of many ways to install Python 2.7 on macOS.

brew install pyenv
pyenv init # Follow the steps presented in the output

Close your shell and start a new one to ensure that pyenv is initialized.

pyenv install 2.7

1. Install Xcode Command Line Tools:

Run the following command to install the Xcode Command Line Tools:

xcode-select --install

⁠Linux Additional Steps

JustDo is fully supported on Linux. No further steps are required.

⁠Windows Users

As of now, JustDo is not officially supported on Windows. However, you can run JustDo on Windows using the Windows Subsystem for Linux (WSL) or a virtual machine.

⁠Step 2: Clone the Repository

Clone the JustDo repository and its submodules:

git clone --recursive [email protected]:justdoinc/justdo.git
cd justdo

⁠Step 3: Run JustDo

Start the JustDo application:

./justdo run

The initial setup will take 10-15 minutes to complete - please be patient. Consequitive runs will run much faster.

Once the application is running, you can access it:

• Landing Page (Registration/Login) - http://localhost:4000/⁠
• Main Web App - http://localhost:3000/app⁠

(Note that the default ports for the development environment are different from the Docker environment.)

⁠Maintanance Operations

This section is relevant only if you started the JustDo stack using the docker-compose.yml file from Option 1 or Option 2 above.

⁠Stopping JustDo

If you just want to stop running containers (but keep volumes/data intact):

docker compose -p "justdo" stop

This stops the containers without removing volumes or networks.

⁠Starting JustDo after stopping it

To start the stack:

docker compose -p "justdo" start

⁠Removing JustDo completely

To remove all containers, networks, and volumes associated with the JustDo stack:

docker compose -p "justdo" down

This cleans up everything created by the Compose file except the data stored in volumes.

If you also want to remove the data stored in volumes, run the following command:

Be careful with this command, as it will remove all your data! (you can backup the data before running this command, details under Backup/Restore⁠)

docker compose -p "justdo" down -v

This cleans up everything created by the Compose file, including any data stored in volumes. If you plan to reinstall later, note that you'll be starting from a blank slate - all your data will be removed.

To also remove the JustDo image:

docker rmi justdoinc/justdo

Note we don't remove the mongo image, as it might be used by other stacks.

⁠MongoDB Container Backup/Restore

By default, the setup above doesn't include an automated backup process for MongoDB - backups are your sole responsibility!

The following is a basic example of how to manually back up or restore your data, see it only as a reference to start building your own backup/restore process, with your particular needs in mind.

Backup:

docker exec justdo-mongodb-1 sh -c 'mongodump --username admin --password password --authenticationDatabase admin --archive' > db.dump

This creates a db.dump file in your current directory, containing a snapshot of your MongoDB data.

Restore:

cat db.dump | docker exec -i justdo-mongodb-1 mongorestore --username admin --password password --authenticationDatabase admin --archive

Note
You must replace password in both of the commands above with the actual password.

• If you used Option 1
  The default password is literally password. Running the command as-is should work. This option is not intended for production and is only used when MongoDB is not exposed to external networks.

• If you used Option 2
  Use the password you specified in your docker-compose.yml file.

⁠License

JustDo is released under a Source-Available. Please refer to the LICENSE⁠ of the JustDo repository⁠.

⁠Issues and Feature Requests

If you encounter any issues or have feature requests, please file them on our GitHub Issues page⁠ or subreddit r/justdo⁠.