Skip to content
Ishxn20 edited this page Jun 5, 2024 · 2 revisions

Home

Welcome to the Developer Journal wiki!

Overview

Developer Journal is a comprehensive tool designed to help developers keep track of their projects, tasks, and progress. The tool features a sleek UI with functionalities to add, view, edit, and delete projects and tasks. It also includes a calendar to manage tasks efficiently.

Setup

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/Developer-Journal.git
  2. Navigate to the project directory:

    cd Developer-Journal
  3. Install dependencies:

    npm install
  4. Run the project:

    npm start
  5. Open your browser and navigate to:

    http://localhost:3000
    

Features

Project Management

  • Add Project: Create a new project with a title, description, and image.
  • View Project: View project details including tasks and progress.
  • Edit Project: Edit project details.
  • Delete Project: Remove a project from the list.

Task Management

  • Add Task: Add tasks to a project with a name and due date.
  • Edit Task: Modify task details.
  • Delete Task: Remove tasks from a project.
  • Task Progress: Track the completion progress of tasks.

Calendar

  • View Calendar: See an overview of tasks for each day.
  • Navigate Calendar: Move between months to see tasks.

Inspirational Quotes

  • Random Quotes: Display a random inspirational quote each day.

Usage

Adding a Project

  1. Click on the "+" button to open the add project modal.
  2. Fill in the project name, description, and image URL.
  3. Click "Add Project" to save the project.

Viewing a Project

  1. Click on a project card to open the project details modal.
  2. View project details and tasks.

Editing a Project

  1. Click the "Edit" button in the project details modal.
  2. Modify the project information and click "Save".

Deleting a Project

  1. Click the "Delete" button on a project card.
  2. Confirm the deletion.

Adding a Task

  1. In the project details modal, enter the task name and due date.
  2. Click "Add Task" to save the task.

Editing a Task

  1. Click the "Edit" button next to a task.
  2. Modify the task details and click "Save".

Deleting a Task

  1. Click the "Delete" button next to a task.
  2. Confirm the deletion.

Navigating the Calendar

  1. Use the navigation arrows to move between months.
  2. Click on a date to view or add tasks for that day.

Contributing

How to Contribute

  1. Fork the repository: Click the "Fork" button on the top right of the repository page.

  2. Clone your fork:

    git clone https://github.com/your-username/Developer-Journal.git
  3. Create a branch:

    git checkout -b feature-name
  4. Make your changes: Make your changes to the codebase.

  5. Commit your changes:

    git commit -m "Description of changes"
  6. Push to your fork:

    git push origin feature-name
  7. Create a pull request: Go to the original repository and click the "New Pull Request" button.