https://github.com/vovoka-path/todo-app-event-emitter
An example of using Event Emitter for my mentees.
https://github.com/vovoka-path/todo-app-event-emitter
Last synced: about 1 month ago
JSON representation
An example of using Event Emitter for my mentees.
- Host: GitHub
- URL: https://github.com/vovoka-path/todo-app-event-emitter
- Owner: vovoka-path
- Created: 2025-03-15T18:58:32.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-15T19:20:01.000Z (about 2 months ago)
- Last Synced: 2025-03-15T20:22:06.097Z (about 2 months ago)
- Language: TypeScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# todo-app-event-emitter
An example of using Event Emitter for my mentees.
## Table of Contents
- [Description](#description)
- [Installation](#installation)
- [Usage](#usage)
- [Scripts](#scripts)
- [Dependencies](#dependencies)
- [Contributing](#contributing)
- [License](#license)
## Description
This project demonstrates the use of the Event Emitter pattern in a simple Todo application. It's designed as an educational tool for mentees to understand how to implement reactive state management using vanilla JavaScript and TypeScript.
## Installation
1. **Clone the repository:**
```bash
git clone https://github.com/vovoka-path/todo-app-event-emitter.git
```
2. **Navigate to the project directory:**
```bash
cd todo-app-event-emitter
```
3. **Install dependencies using Yarn:**
```bash
yarn install
```
## Usage
1. **Start the development server:**
```bash
yarn dev
```
2. **Open the application in your browser:**
The application will be available at `http://localhost:5173` (or the port Vite assigns).
3. **Build for production:**
```bash
yarn build
```
4. **Preview the production build:**
```bash
yarn preview
```
## Scripts
- `yarn dev`: Starts the development server using Vite.
- `yarn build`: Builds the project for production using TypeScript and Vite.
- `yarn preview`: Starts a local server to preview the production build.
## Dependencies
### Development Dependencies
- `typescript`: Used for static typing.
- `vite`: Used as a build tool and development server.
## Contributing
Contributions are welcome! If you find a bug or have an idea for an improvement, please open an issue or submit a pull request.
1. **Fork the repository.**
2. **Create a new branch from `develop` for your feature or bug fix.**
3. **Make your changes.**
4. **Commit your changes and push them to your fork.**
5. **Submit a pull request from your new branch to `develop`.**
## License
This project is licensed under the [MIT License](LICENSE) - see the `LICENSE` file for details. (If you have a license file, add this section. If not, remove it or add a license).