Skip to content

Latest commit

 

History

History
166 lines (107 loc) · 6.26 KB

README.md

File metadata and controls

166 lines (107 loc) · 6.26 KB
Raw

Visionize

Visualize and realize your vision with Visionize, a productivity application that allows you to organize your tasks and projects using boards, lists and cards.

Whether you are using individually or collaborating with a team, you can use this app to set goals, track progress and manage deadlines.

Inspired by Kanban, (看板, meaning signboard or billboard in Japanese), a tool used to both visualize and optimize the flow of work. See kanban section to learn more.

Description

Based on the kanban method, this app is a tool to visualize workflow in three steps:

  1. To Do
  2. In Progress
  3. Done

While using only three components:

  1. Boards, where tasks are organized
  2. Lists, displays the different stages of a task (To Do, In Progress, Done)
  3. Cards, which represent tasks, ideas and information

It also has an audit log, a record of events and changes, to enhance collaboration.

Uses Next.js 14, with features such as Server Actions.

Technologies:

  • Next.JS 14
  • TypeScript
  • React
  • TailwindCSS
  • PostgreSQL and Prisma ORM for database
  • Clerk for authentication
  • Stripe API for payment handling
  • zustand for state management
  • shadcn/ui for component collection

Specifications

  • User can create, read, update and delete boards
  • User can create, read, update and delete lists
  • User can create, read, update and delete cards
  • Users can view activity history with audit logs

Implementation Checklist

  • Boards
  • Lists
  • Cards
  • Audit Log
  • Settings page
  • Integrate Freemium Model (for practice)

Prerequisites

  • Node version 14 or higher

Instructions to run locally

1. Clone this repo (or download zip on GitHub)

2. Go to the directory the files are located

In the terminal:

```powershell
cd /visionize
```

3. Install dependencies

In the terminal:

```powershell
npm run install
```

4. Generate Prisma Client

If the postinstall script does not run after installing the dependencies, then do the following:

In the terminal:

```powershell
npx prisma generate
```

The command npx prisma generate creates the Prisma Client, which is a set of auto-generated functions tailored to your database schema. This client allows you to easily interact with your database in your code. Essentially, it updates the client whenever you make changes to your Prisma schema.

5. Create an .env file

Create the .env file at the base of the project. It should contain the following environment variables:

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/org-selection
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/org-selection

DATABASE_URL=
NEXT_PUBLIC_UNSPLASH_ACCESS_KEY=
STRIPE_API_KEY=
NEXT_PUBLIC_APP_URL=http://localhost:3000
STRIPE_WEBHOOK_SECRET=

  • To get the keys NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY, CLERK_SECRET_KEY follow the documentation with Clerk quick start.

  • To create your local DATABASE_URL, install PostgreSQL on your local machine. Follow this guide: set up a local postgresql database | Prisma

  • For image API generation, create an account with Unsplash Image API and follow the Unsplash documentation - Getting started to get the NEXT_PUBLIC_UNSPLASH_ACCESS_KEY.

  • For payment handling, create an account with Stripe and in the Developers tab get the key for STRIPE_API_KEY.

  • While still logged-in the Stripe dashboard, click the Webhooks tab or navigate to https://dashboard.stripe.com/test/webhooks. Click on "Test in a local environment" and follow the instructions.

    • Using the Stripe CLI run the command stripe login in the terminal of your choice
    • Forward your events to the webhook with the command: stripe listen --forward-to localhost:3000/api/webhook
    • Then you will get the webhook signing secret value from the terminal, save this as the value to STRIPE_WEBHOOK_SECRET in your environment variables.

With your environment variables all set up, you are not ready to run the app locally.

6. Run the app locally

In the terminal:

```powershell
npm run dev
```

Then with the browser of your choice, navigate to the link: http://localhost:3000

7. Use the app

You can now create boards, lists and cards within an organization.

Kanban

Kanban, (看板, meaning signboard or billboard in Japanese), a lean method to manage and improve work across human systems.

Benefits to use:

  • Traceability
  • Collaboration
  • Accessibility

This approach aims to manage work by balancing demands with available capacity, and by improving the handling of system-level bottlenecks.

Work items are visualized to give participants a view of progress and process, from start to finish—usually via a kanban board. Work is pulled as capacity permits, rather than work being pushed into the process when requested.

In knowledge work and in software development, the aim is to provide a visual process management system which aids decision-making about what, when, and how much to produce. The underlying kanban method originated in lean manufacturing, which was inspired by the Toyota Production System.

Kanban guide

Audit logging and Kanban

According to the The Kaban Guide (2020)(by John Colemane and Daniel Vacanti), the Kanban strategy optimizes the flow of value through a process that uses a visual, pull-based system.

"Kanban comprises the following three practices working in tandem:

  1. Defining and visualizing a workflow
  2. Actively managing items in a workflow
  3. Improving a workflow

In their implementation, these Kanban practices are collectively called a Kanban system. Those who participate in the value delivery of a Kanban system are called Kanban system members."