Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 2.8 KB

README.md

File metadata and controls

75 lines (58 loc) · 2.8 KB

Todo App

Description

This Todo app is a full-stack web application built using Vite for the React client, and Node.js with Express for the server. It utilizes MongoDB for data storage, providing a responsive and interactive experience for managing tasks.

Video Demo: https://www.loom.com/share/10522e7829854780a6915841323f5eee?sid=00905834-6575-4a91-aee9-e9183935373a

ScreenShots

Some snapshots of the project : Screenshot 2023-12-13 at 6 32 14 AM Screenshot 2023-12-13 at 6 32 27 AM Screenshot 2023-12-13 at 6 32 38 AM Screenshot 2023-12-13 at 6 33 30 AM

Features

  • User authentication and authorization
  • Add, delete, and update tasks
  • Real-time updates with a responsive UI
  • Persistent storage with MongoDB
  • User profiles with avatars.
  • Search task
  • Add status of task

Technologies

  • Frontend: React (created with Vite)
  • Backend: Node.js, Express
  • Database: MongoDB
  • Styling: Tailwind CSS

Getting Started

Prerequisites

  • Node.js
  • npm or Yarn
  • MongoDB

Installation

  1. Clone the repository:

    git clone https://github.com/Siddharth-Dagar-25/todo-application
    
  2. Install dependencies for the server:

    npm install
    
    
  3. Install dependencies for the client:

    npm install
    
    
  4. Set up environment variables: In the server directory, create a .env file and configure your environment variables (e.g., database URI, port number).

  5. Start the server:

    npm run dev
    
    
  6. Start the client:

    npm run dev
    
    

Contributing

I welcome any and all contributions! Here are some ways you can get started:

  • Report bugs: If you encounter any bugs, please let us know. Open up an issue and let us know the problem.
  • Contribute code: If you are a developer and want to contribute, follow the instructions below to get started!
  • Suggestions: If you don't want to code but have some awesome ideas, open up an issue explaining some updates or imporvements you would like to see!
  • Documentation: If you see the need for some additional documentation, feel free to add some!

Instructions

  • Fork this repository
  • Clone the forked repository
  • Add your contributions (code or documentation)
  • Commit and push
  • Wait for pull request to be merged