Timy ⏱️

Effortlessly master your time with Timy ⏱️ – the sleek Single-Page Application (SPA) designed for seamless activity tracking. Run Timy ⏱️ directly on your device to monitor tasks, while harnessing cloud integration for multi-device access. Timy ⏱️: compact, responsive, and tailored for your individual productivity.

See Demo: https://manud99.github.io/timy/

Setup

To install this project you must have a Google Account and Node 18 (current LTS) or newer on your machine.

1. Clone the repository using Git git clone git@github.com:manud99/timy.git or download and extract the Zip folder.
2. Run in your shell:

   cp .env.local.example .env.local

3. Go to the Google API Console. Click Create project, enter a name, and click Create.
4. Open this page Google Calendar API and click Enable.
5. On the Credentials page click on Create Credentials and Create OAuth client ID.
6. As Application Type select Web application and enter an appropriate Name.
7. Under Authorised JavaScript origins click on Add URI and enter the address you want Timy to run on - default is http://localhost:5173. Do the same in the Authorised redirect URIs section.
8. Click on Create.
9. Copy the Client ID and paste it in .env.local after the key VITE_GOOGLE_CLIENT_ID.
10. Start the Vite server with

    npm run dev

11. Open the app on http://localhost:5173.

Contributing

If you have questions or discover a bug please report by creating an issue. PRs are always welcome.

Development

For development we recommend using VS Code with Volar and TypeScript Vue Plugin (Volar) extensions.

Type Support For .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

License

Timy is open-sourced software licensed under the MIT license. See LICENSE.txt.

Credits

Template is adapted from: https://github.com/estevanmaito/windmill-dashboard Icons are from: https://iconmonstr.com/