Skip to content

ricci2511/openkban

Repository files navigation

Openkban

⚠️ EARLY in development ⚠️

You're welcome to take a look but don't expect it to be ready to use.

Openkban (i know, not the most creative name) is a open source kanban web app built with nextjs.

Motivation

My main goal is to improve my developer skills, but aside from that I'm trying to build a simple, modern and free kanban web app.

Getting started

  1. Clone the repo and cd into it:

    git clone https://github.com/ricci2511/openkban.git
    cd openkban
    
  2. Create a .env file with the contents of .env.example. The example file includes instructions that should be followed before proceeding (getting keys for OAuth providers).

    cp .env.example .env
    
  3. Install dependencies:

    npm install
    
  4. Run mysql and redis containers:

    // pass the -d flag if you don't want to see docker logs
    docker-compose up
  5. If you are running the containers for the first time you need to synchronize the mysql schema with the prisma schema:

    npx prisma db push
    
  6. You are ready to run the app with:

    // listening on localhost:3000
    npm run dev

License

MIT