adel-gu/Todo-typescript

Simple web application that I built for the purpose of learning and practicing TypeScript. The app allows users to add, edit, remove, and check completed daily tasks.

TODO 🎯

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 TODO TypeScript

TODO TypeScript is a simple web application that I built for the purpose of learning and practicing TypeScript. The app allows users to add, edit, remove, and check completed daily tasks. It is designed to help users keep track of their daily to-do lists and stay organized. With TypeScript, the app offers type checking and static analysis, ensuring that the code is more reliable and maintainable.👍

🖼️ Preview

🛠 Built With

Tech Stack

• HTML
• TailwindCSS
• TypeScript
• Snowpack

Key Features

• Add a task
• Edit a task title
• Check completed task
• Remove completed task

(back to top)

🚀 Live Demo

• Click and checkout the live demo 🚀.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

First you need the following tools:

• Browser such as (Chrome, FireFox, ...etc)
• A Code Editor such as (VsCode, Sublime or Atom)
• A package manager such as (npm or yarn)
• Node.js should be installed on your local machine, download nodejs if not.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:adel-gu/Todo-typescript.git

Install

• Install this project using yarn:

  cd Todo-typescript
  yarn install

• And if you are using npm, ensure to delete the file [yarn.lock] and run:

  cd Todo-typescript
  npm install

Usage

To run the project, execute the following command:

  yarn start

If you are using npm:

  npm start

Deployment

You can deploy this project using netlify cli, or from the official website of Netlify.

(back to top)

👥 Author

👤 Adel GUITOUN

• GitHub: @adel-gu
• Twitter: @GuitounAdel
• LinkedIn: adelguitoun

(back to top)

🔭 Future Features

• Add the functionality of drag and drop completed task to the completed section

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project and you find it a helpfull to get an idea of how typescript works, feel free to clone it and please leave a start ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microsoft Corporation for Typescript 👍 and the way its documentation is structured.

(back to top)

📝 License

This project is MIT licensed.

(back to top)