coLlenz / kanboard

📃 KanBoard - Your personal project management tool

Introducing KanBoard 🚀✨

Your Personal Project Management Tool

Installation 📄

In order to set up your own instance of KanBoard, you must first install Docker, set up Appwrite, create necessary data collections, clone the KanBoard repo, and configure environmental variables.

We will go through everything in more detail below:

1️⃣ To install Docker, check the official installation guidelines here.

2️⃣ Next, you have to install the Appwrite using the commands below, depending on the operating system you use:

• Mac / Linux or Unix compatible:

docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:latest

• Windows (command prompt)

docker run -it --rm ^
    --volume //var/run/docker.sock:/var/run/docker.sock ^
    --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
    --entrypoint="install" ^
    appwrite/appwrite:latest

• Windows (powershell)

docker run -it --rm ,
    --volume /var/run/docker.sock:/var/run/docker.sock ,
    --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw ,
    --entrypoint="install" ,
    appwrite/appwrite:latest

3️⃣ Next, open Docker and run the Appwrite app. At this point, you should be able to access the Appwrite console through localhost. Create an account, log in and create a new project.

4️⃣ To init your SDK and interact with Appwrite services, you need to add a Web platform to your project. To do that choose the project you created and click the 'Add Platform' button.

5️⃣ Create four database collections: Posts, Columns, Boards, and Activities.

Now set the attributes and indexes for each collection as below:

🔻 Posts attributes and indexes

🔻 Columns attributes and indexes

🔻 Boards attributes

🔻 Activities attributes

6️⃣ Go into the settings for each collection and set the permission to role:member for both read and write access.

7️⃣ Navigate to the Users panel and add a new user you will use to log in to your app and access KanBoard.

8️⃣ Clone the repo to your machine by running git clone https://github.com/madzadev/kanboard.git then change the working directory into it by cd kanboard and install the project packages by npm install.

9️⃣ Clone the env files with the command cp .env.example .env.local. In the newly created .env.local file fill out the keys from your Appwrite console. The first two are available in the Settings of the KanBan project. The other four can be found in the Settings of each Collection.

1️⃣0️⃣ Run the command npm run dev to start the app.

License 📃

KanBoard is an open-source project with MIT license.

The pull requests are welcome.