Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Keith-Web3 authored May 13, 2023
1 parent 74e4a67 commit f25ed40
Showing 1 changed file with 53 additions and 2 deletions.
55 changes: 53 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,53 @@
# Kanban-Task-Manager
⚠️⚠️This project is still in development.
# Kanban Task Management App
This is a Kanban Task Management app built with React, TypeScript, and Zustand. It allows you to create, organize, and track tasks using a Kanban board interface.

## Features
* Create, edit, and delete tasks
* Drag and drop tasks between different columns (e.g., "To Do", "In Progress", "Done")
* Automatically save task updates using Zustand for state management
* Responsive design for a seamless experience across devices

## Getting Started
To get started with the Kanban Task Management app, follow these steps:

### Clone the repository:
```html
git clone https://github.com/keith-web3/kanban-task-manager.git
```
### Navigate to the project directory:

```html
cd kanban-task-manager
```
### Install dependencies:
```html
npm install
```
### Start the development server:

```html
npm start
```
This will start the app in development mode. Open[ http://localhost:3000](http://127.0.0.1:5173/) in your web browser to access the Kanban Task Management app.

## Technologies Used
The Kanban Task Management app is built with the following technologies:

* React: A JavaScript library for building user interfaces
* TypeScript: A typed superset of JavaScript
* Zustand: A small and fast state management library for React applications
## Contributing
Contributions to the Kanban Task Management app are welcome! If you find any issues or would like to add new features, please submit a pull request with your changes.

Before submitting a pull request, make sure to run the tests and format the code:

```html
npm test
npm run lint
npm run format
```
## License
This project is licensed under the MIT License. See the LICENSE file for more information.

## Acknowledgments
The Kanban Task Management app was inspired by the popular Kanban methodology for project management and the need for a simple and efficient task tracking tool. Design attribution goes to the team at [frontendmentor](frontendmentor.io)

0 comments on commit f25ed40

Please sign in to comment.