Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pushkar-2804/kanban-task-management
https://github.com/pushkar-2804/kanban-task-management
Last synced: about 13 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/pushkar-2804/kanban-task-management
- Owner: pushkar-2804
- Created: 2023-08-07T17:50:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-04T23:11:07.000Z (over 1 year ago)
- Last Synced: 2023-09-05T08:05:46.144Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 358 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```markdown
# Kanban Task Management
Kanban Task Management is a web-based task management application that allows you to organize and track your tasks using a Kanban board. This README provides instructions for setting up and running the project.
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setting Up](#setting-up)
- [Server Configuration](#server-configuration)
- [Client Configuration](#client-configuration)
- [Running the Application](#running-the-application)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
### Prerequisites
Before you can run the application, make sure you have the following prerequisites installed:
- Node.js: You can download it from [nodejs.org](https://nodejs.org/).
- MongoDB: Ensure you have a MongoDB instance running and note down the connection URI.
### Setting Up
1. Clone the repository:
```bash
git clone https://github.com/pushkar-2804/Kanban-Task-Management.git
cd Kanban-Task-Management
```
2. Create environment variables for the server by creating a `.env` file in the `server` directory with the following content:
```
MONGO_URI=
JWT_SECRET=
```
Replace `` and `` with your actual MongoDB connection URI and a secure JWT secret key.
## Server Configuration
1. Navigate to the server directory:
```bash
cd server
```
2. Install server dependencies:
```bash
npm install
```
## Client Configuration
1. Navigate to the client directory:
```bash
cd client
```
2. Install client dependencies:
```bash
npm install
```
## Running the Application
1. Start the server:
```bash
cd server
npm start
```
The server should now be running on port 3000 by default.
2. Start the client:
```bash
cd client
npm run dev
```
The client application should open in your default web browser.
## Contributing
If you'd like to contribute to this project, please read the [Contributing Guidelines](CONTRIBUTING.md).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
```