https://github.com/firatgoktepe/jiraf

Jiraf - issue tracking and agile project management app
https://github.com/firatgoktepe/jiraf

appwrite honojs nextjs14 reactjs shadcn-ui tailwindcss typescript

Last synced: 6 days ago
JSON representation

Jiraf - issue tracking and agile project management app

• Host: GitHub
• URL: https://github.com/firatgoktepe/jiraf
• Owner: firatgoktepe
• Created: 2024-10-12T12:01:44.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-18T17:41:32.000Z (4 months ago)
• Last Synced: 2024-10-19T15:02:47.934Z (4 months ago)
• Topics: appwrite, honojs, nextjs14, reactjs, shadcn-ui, tailwindcss, typescript
• Language: TypeScript
• Homepage:
• Size: 628 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## 📋 Table of Contents

1. 🤖 [Introduction](#introduction)

2. ⚙️ [Tech Stack](#tech-stack)

3. 🔋 [Features](#features)

4. 🤸 [Quick Start](#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](https://nextjs.org/) (React Framework)

- [Appwrite](https://appwrite.io/) (for database, an ORM tool, file storage, Messaging and authentication)

- [Hono.js](https://hono.dev/) (for node.js framework / an Express alternative)

- [TypeScript 5](https://www.typescriptlang.org/) (Type Checking)

- [Tailwind CSS 3.4.1](https://tailwindcss.com/) (Styling)

- [ShadCN](https://ui.shadcn.com/) (UI Components)

- [ESLint 8](https://eslint.org/) (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](https://git-scm.com/)

- [Node.js](https://nodejs.org/en)

- [npm](https://www.npmjs.com/) (Node Package Manager)

**Cloning the Repository**

```bash

git clone [email protected]:firatgoktepe/jiraf.git

cd jiraf

```

**Installation**

Install the project dependencies using npm:

```bash

npm install

```

**Set Up Environment Variables**

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

```env

#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](https://appwrite.io/).

**Running the Project**

```bash

npm run dev

```

Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.