📋 Table of Contents

1. 🤖 Introduction
2. ⚙️ Tech Stack
3. 🔋 Features
4. 🤸 Quick Start

Live: https://jiraf.vercel.app

🤖 Introduction

Jiraf is an issue tracking and agile project management app all built using Next.js.

⚙️ Tech Stack

• Next.js 14 (React Framework)
• Appwrite (for database, an ORM tool, file storage, Messaging and authentication)
• Hono.js (for node.js framework / an Express alternative)
• TypeScript 5 (Type Checking)
• Tailwind CSS 3.4.1 (Styling)
• ShadCN (UI Components)
• ESLint 8 (Code Linting)

🔋 Features

• 🏢 Workspaces
• 📊 Projects / Epics
• ✅ Tasks
• 📋 Kanban Board View
• 🗃️ Data Table View
• 📅 Calendar View
• ✉️ Invite System
• ⚙️ Workspace and Project Settings
• 🖼️ Image Uploads (for avatars and attachments)
• 🔌 Appwrite SDK Integration
• 🎨 Shadcn UI & TailwindCSS Styling
• 🔍 Advanced Search and Filtering
• 📈 Analytics Dashboard
• 👥 User Roles and Permissions
• 🔒 Authentication (OAuth and Email)
• 📱 Responsive Design (Mobile-friendly)
• 🚀 API using Hono.js

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Git
• Node.js
• npm (Node Package Manager)

Cloning the Repository

git clone git@github.com:firatgoktepe/jiraf.git
cd jiraf

Installation

Install the project dependencies using npm:

npm install

Set Up Environment Variables

Create a new file named .env.local in the root of your project and add the following content:

#APPWRITE
NEXT_PUBLIC_APP_URL=http://localhost:3000

NEXT_PUBLIC_APPWRITE_ENDPOINT=https://cloud.appwrite.io/v1
NEXT_PUBLIC_APPWRITE_PROJECT=[Your key]

NEXT_PUBLIC_APPWRITE_DATABASE_ID=[Your key]
NEXT_PUBLIC_APPWRITE_WORKSPACES_ID=[Your key]
NEXT_PUBLIC_APPWRITE_MEMBERS_ID=[Your key]
NEXT_PUBLIC_APPWRITE_PROJECTS_ID=[Your key]
NEXT_PUBLIC_APPWRITE_TASKS_ID=[Your key]
NEXT_PUBLIC_APPWRITE_IMAGES_BUCKET_ID=[Your key]

NEXT_APPWRITE_KEY=[Your key]

Replace the placeholder values with your actual Appwrite credentials. You can obtain these credentials by signing up on the Appwrite website.

Running the Project

npm run dev

Open http://localhost:3000 in your browser to view the project.