Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amanmalviya22/task-manager-api
Created a task management API using the MERN tech stack. Here, you can create users, add tasks, and add subtasks for a particular task.
https://github.com/amanmalviya22/task-manager-api
Last synced: about 1 month ago
JSON representation
Created a task management API using the MERN tech stack. Here, you can create users, add tasks, and add subtasks for a particular task.
- Host: GitHub
- URL: https://github.com/amanmalviya22/task-manager-api
- Owner: AmanMalviya22
- Created: 2024-07-25T12:06:09.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-25T12:59:52.000Z (5 months ago)
- Last Synced: 2024-07-25T14:29:29.896Z (5 months ago)
- Language: JavaScript
- Homepage: http://localhost:3000
- Size: 18.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Task Management API
## Overview
This project is a task management API built using the MERN tech stack (MongoDB, Express.js, React, Node.js). It allows users to manage tasks and subtasks efficiently.
## Features
- **User Management:** Create and manage users.
- **Task Management:** Add, update, and delete tasks.
- **Subtask Management:** Add, update, and delete subtasks for each task.
## Tech Stack
- **MongoDB:** NoSQL database for storing user and task data.
- **Express.js:** Web framework for Node.js, used for building the API.
- **React:** Frontend library for building user interfaces (if included).
- **Node.js:** JavaScript runtime for building the server-side application.
## Getting Started
### Prerequisites
- Node.js (v14 or later)
- MongoDB (local installation or a cloud service like MongoDB Atlas)
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/AmanMalviya22/task-manager-api.git
cd task-management-api
```
2. **Install dependencies:**
```bash
npm install
```
3. **Configure environment variables:**
Create a `.env` file in the root directory and add the following variables:
```env
MONGO_URI=your-mongodb-connection-string
PORT=your-desired-port
```
4. **Run the application:**
```bash
npm start
```
### API Endpoints
### API Documentation URL
https://documenter.getpostman.com/view/28291997/2sA3kYgz6j
### Database Schema Documentation URL
https://dbdiagram.io/d/TaskManagerApi-aman-malviya-66a244838b4bb5230e567a18
## Contributing
1. **Fork the repository**
2. **Create a new branch:**
```bash
git checkout -b feature/your-feature
```
3. **Make your changes**
4. **Commit your changes:**
```bash
git commit -am 'Add new feature'
```
5. **Push to the branch:**
```bash
git push origin feature/your-feature
```
6. **Create a new Pull Request**
## License
This project is licensed under the MIT Licens
## Acknowledgments
- **MERN stack**: For providing a robust technology stack for building modern web applications.
---