Welcome to the TODO App Client repository! This project is developed as part of a Skill Safari curriculum to demonstrate a comprehensive understanding of the MERN (MongoDB, Express, React, Node.js) stack. The app showcases CRUD (Create, Read, Update, Delete) operations, utilizing Postman for API testing, and MongoDB for database management.
- Introduction
- Features
- Live Demo
- Server Repository
- Features
- Installation
- Usage
- Technologies Used
- Contributing
- Acknowledgments
Check out the live demo of the TODO app here.
You can view the server/backend repository here.
- Create: Add new tasks to your TODO list.
- Read: View all your tasks in one place.
- Update: Edit task details, including task descriptions.
- Delete: Remove tasks that are no longer needed.
To run this project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/your-username/todo-app-mern.git cd todo-app-mern
-
Install server dependencies:
cd server npm install
-
Install client dependencies:
cd ../client npm install
-
Set up the environment variables:
- Create a
.env
file in theserver
directory and add the following:
PORT=5000 MONGODB_URI=your_mongodb_uri
- Create a
-
Run the server:
cd ../server npm start
-
Run the client:
cd ../client npm start
Once the server and client are running, you can access the TODO app in your web browser at http://localhost:3000
.
To test the API endpoints, you can use Postman or any other API testing tool. Below are the available endpoints:
- GET /todos: Retrieve all tasks.
- POST /save: Create a new task.
- Request body:
{ "text": "Task description" }
- Request body:
- POST /update: Update an existing task.
- Request body:
{ "_id": "task_id", "text": "Updated task description" }
- Request body:
- DELETE /delete/:id: Delete a task by ID.
- MongoDB: Database for storing tasks.
- Express: Web framework for building the API.
- React: Frontend library for building the user interface.
- Node.js: JavaScript runtime for the server.
- Postman: Tool for API testing.
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
This project is developed as part of the Skill Safari curriculum. Special thanks to Skill Safari for providing the learning resources and guidance.
Happy coding!