realtalishaw / todo-app-ai

Starter React ToDo App

This is a simple and intuitive ToDo application built with React for managing daily tasks with user authentication.

Table of Contents

• Installation
• Usage
• Testing
• Deployment

Installation

Clone the repository and install dependencies.

git clone https://github.com/username/starter-react-todo-app.git
cd starter-react-todo-app
npm install

Usage

Start the server.

npm start

The application will be available at http://localhost:3000.

Pages

• Login Page: For user authentication (src/components/LoginPage.js)
• Registration Page: For new user sign-up (src/components/RegistrationPage.js)
• ToDo Dashboard: Main interface for task management after login (src/components/ToDoDashboard.js)

Components

• Task List: Displays all tasks (src/components/TaskList.js)
• Task Item: Individual task display with options to update or delete (src/components/TaskItem.js)
• Add Task Form: For creating new tasks (src/components/AddTaskForm.js)
• Navigation Bar: Links to different pages, logout button (src/components/NavigationBar.js)

API Endpoints

• User Authentication: /api/auth/register, /api/auth/login
• Task Management:
  • Create Task: POST /api/tasks
  • Read Tasks: GET /api/tasks
  • Update Task: PUT /api/tasks/:id
  • Delete Task: DELETE /api/tasks/:id

Testing

Run the tests.

npm test

Deployment

The application can be deployed on platforms like Heroku, Vercel, or Netlify for front-end; Heroku or AWS for back-end.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT