https://github.com/ricci2511/openkban

Open Source Kanban web app built with Next
https://github.com/ricci2511/openkban

nextjs planetscale prisma react redis tailwindcss trpc typescript

Last synced: 3 months ago
JSON representation

Open Source Kanban web app built with Next

• Host: GitHub
• URL: https://github.com/ricci2511/openkban
• Owner: ricci2511
• License: mit
• Created: 2022-08-27T16:01:27.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-06-01T18:08:10.000Z (over 1 year ago)
• Last Synced: 2023-06-01T19:24:49.827Z (over 1 year ago)
• Topics: nextjs, planetscale, prisma, react, redis, tailwindcss, trpc, typescript
• Language: TypeScript
• Homepage: https://openkban.vercel.app/
• Size: 1.03 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Openkban

:warning: EARLY in development :warning:

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:

    ```javascript

    // 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:

    ```javascript

    // listening on localhost:3000

    npm run dev

    ```

## License

MIT