Octo Eureka

Octo Eureka is a sleek and intuitive to-do app designed to significantly boost your productivity. With its user-friendly interface, you can effortlessly manage tasks and achieve more by simply embracing the “just do it” mindset.

🛠️ Getting Started

Follow the steps below to set up and run Octo Eureka locally:

1. Clone the Repository

First, clone this repo and navigate to the project’s root directory:

git clone https://github.com/your-username/octo-eureka.git
cd octo-eureka

2. Install Dependencies

Make sure you have a package manager installed (pnpm, npm, or yarn). This project uses pnpm, but you can use any of the following commands:

pnpm install  # or npm install, yarn install

3. Run the App (Development Mode)

To start the app with hot-reload during development, use:

pnpm dev  # or npm run dev, yarn dev

4. Build for Production

To compile, type-check, and minify the app for production:

pnpm build  # or npm run build, yarn build

5. Run Unit Test

To run the unit test with one time, to watch for changes and show unit test coverage

pnpm test:unit  # or npm run test:unit, yarn test:unit
pnpm test:watch  # or npm run test:watch, yarn test:watch
pnpm test:coverage  # or npm run test:coverage, yarn test:coverage

6. Run End to End Test

To run the end-to-end (E2E) test

pnpm test:e2e  # or npm run test:e2e, yarn test:e2e

Tech Stack

Here are list of tech and tools I used to create this project:

Front-end

• Vue 3 Typescript with <script setup>
• TailwindCSS
• Icons for icones.js.org

State Management

• Pinia
• Pinia Persisted State Plugin
• Zipson

Testing

• Vitest
• Playwright
• Pinia Tests

Utilties

• Vueuse/core
• Zipson
• DayJS

What Have I Done?

• Add basic features for MVP todo app
  • ADD, EDIT & DELELE todo
• Create a modal for dropdown menu
• Create priority dropdown and add priority to todo item
• Add sidebar for editing items
• Add subtask functionality
• Add light/dark mode
• Add due date functions
• Add basic filter functionality
  • ALL, COMPLETED & ON-GOING TODOS
• Add pinia state to local storage
• Add auto-version using semantic-release
  • generate release notes & change log
• Start writing test for the app
  • 100% coverage for pinia store and utils funcs
  • playwright test for adding todo (CI was added for this!)

What Am I Working?

• Add setting feature
  • Input validation & App limitation
  • Custom Accent Color
  • clearing data
  • Visualization
• Create a demo of the app
• Add vuefire and firebase to add for push notification

💡 Note:
Please check out the CHANGELOG.md to see a full list of the features I have worked on, because the list above may not be exhaustive.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.