Skip to content

namanpunn/Zappit_task_Manager

Repository files navigation

ZAPPIT TASK MANAGER

Table of Contents

  1. Project Overview
  2. Tech Stack
  3. Installation
  4. Running the Application
  5. Environment Variables
  6. Testing

Project Overview

Zappit Task Manager is a task manager which help organization to manage all their Projects at a Zappit Platform

Tech Stack

This project uses:

  • Next.js - for server-side rendering and frontend development
  • Tailwind CSS - for utility-first styling
  • Clerk - for authentication and user management
  • Neon DB - for database management
  • ShadCN UI - for component styling and design consistency

Installation

Prerequisites

Ensure you have these installed:

Steps

  1. Clone the repository:
    git clone https://github.com/your-username/your-repo-name.git
    
  2. Change into the project directory:
     cd your-repo-name
    
  3. Install dependencies:
    npm install
    

Running the Application

  1. Set Up Environment Variables: Create a .env.local file in the root directory, and add the required environment variables (see below).

  2. Start the Development Server

    npm run dev
    

The app will be available at http://localhost:3000.

Environment Variables

In your .env.local file, include:

```bash
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY= <your-clerk-frontend-api-key>
CLERK_SECRET_KEY= <your-clerk-api-key>

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/onboarding

DATABASE_URL= <your-neon-db-url>

Testing

To run tests, use the following command:

npm test

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors