Skip to content

Latest commit

 

History

History
148 lines (109 loc) · 2.96 KB

README.md

File metadata and controls

148 lines (109 loc) · 2.96 KB

To-Do App

A simple and elegant To-Do app built with React and Vite. This app helps you manage your daily tasks efficiently and with a minimalistic design.

Features

  • Add, edit, and delete tasks.
  • Mark tasks as completed.
  • Responsive design for all devices.
  • Built with modern technologies: React, Vite, and Tailwind CSS.

Live Demo

Check the live app here

Getting Started

Follow the steps below to set up and run the app on your local machine.

Prerequisites

Make sure you have the following installed:

  • Node.js (v16 or later)
  • npm or yarn

Step 1: Clone the Repository

Clone this repository to your local machine:

git clone https://github.com/dopemukesh/ormat-todolist.git

Step 2: Navigate to the Project Directory

Move into the project folder:

cd ormat-todolist

Step 3: Install Dependencies

Install all the required packages using npm or yarn:

npm install

Step 4: Run the App

Start the development server:

npm run dev

You will see output similar to this:

  VITE v4.0.0  ready in 500ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: http://192.168.x.x:5173/

Open http://localhost:5173/ in your browser to see the app.

Step 5: Build for Production

To create an optimized production build:

npm run build

The build files will be generated in the dist folder.

Step 6: Preview the Production Build

To preview the production build locally:

npm run preview

Folder Structure

ormat-todolist/
├── public/          # Static assets (e.g., icons, images)
├── src/             # Source code
│   ├── components/  # Reusable components
│   ├── pages/       # Page components
│   ├── App.jsx      # Main app component
│   └── main.jsx     # Entry point
├── package.json     # Project metadata and dependencies
├── vite.config.js   # Vite configuration
└── README.md        # Documentation

Technologies Used

  • Frontend: React, Vite
  • Styling: Tailwind CSS
  • State Management: React useState and useEffect hooks

Contributing

Contributions are welcome! Follow these steps:

  1. Fork this repository.
  2. Create a new branch: 
    git checkout -b feature-your-feature-name
  3. Commit your changes: 
    git commit -m "Add your feature"
  4. Push to the branch: 
    git push origin feature-your-feature-name
  5. Open a pull request.

Author

License

This project is licensed under the MIT License.

Happy coding! 😊