Skip to content

alirezashn79/todox-university-project

Repository files navigation

🚀 Todo Planner - The Ultimate Task Manager For University Project

Welcome to TodoX 🎯 Manage your tasks effortlessly with our advanced features and beautiful design. Now live at todox.ir! 🌟


🛠️ Features

  • User-Friendly UI: Intuitive and sleek design powered by Next.js and TailwindCSS.
  • Authentication: Secure login with email, password, and OTP verification.
  • Real-Time Notifications: Stay updated with task changes in real-time.
  • Multi-Device Support: Access your tasks from any device.
  • Customizable Task Views: Switch between different views for better task management.
  • SMS & Email Integration: Receive reminders and OTPs via SMS and email.

🌍 Live

Explore TodoX live at todox.ir and experience its amazing features! 🚀


🏗️ Tech Stack

Frontend

  • Next.js: For building a highly performant and scalable web application.
  • TailwindCSS: For modern and customizable styling.
  • React-Hook-Form: Simplified form handling.
  • Zustand: Lightweight state management.

Backend

  • Node.js: Server-side runtime.
  • Mongoose: Database modeling with MongoDB.
  • JWT: Secure user authentication.
  • AWS-SDK: For seamless cloud integrations.
  • Nodemailer: Email notifications and OTP.

🚀 Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js: v16 or later
  • MongoDB: Database for storing task data
  • npm or yarn: Package manager

Installation

  1. Clone the repository:

    git clone https://github.com/alirezashn79/todox.git
    cd todox
  2. Install dependencies:

    npm install
  3. Set up environment variables:

    • Copy .env.example to .env.
    • Add your database URI, JWT secret, email credentials, and SMS provider API keys.
  4. Start the application:

    npm run dev

Visit http://localhost:3000 to explore TodoX locally. 🎉


🧪 Testing

  • Frontend: Run ESLint for linting:
    npm run lint
  • Backend: Unit tests coming soon!

🤝 Contributing

We welcome contributions! Follow these steps:

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

📜 License

This project is licensed under the MIT License. Feel free to use, modify, and distribute as needed.


🧑‍💻 Author

Alirezashn79 Feel free to reach out for any questions or collaboration opportunities! ✨


🌟 Acknowledgments

Thanks to all the contributors and the open-source community for their amazing work! 🙌


⚡ Quick Links

About

Manage your tasks effortlessly with our advanced features and beautiful design.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages