Skip to content

dkhalife/tasks-frontend

Repository files navigation

Node.js CI CodeQL Dependabot Updates

Task Wizard Frontend

This repo is a frontend for tasks-backend, a free and open source solution for task management. It started as a fork of DoneTick but has since diverged from the original source code in order to accomplish different goals. Kudos to the contributors of DoneTick for helping kickstart this project.

🎯 Goals and principles

Task Wizard's primary goal is to allow users to own and protect their data and the following principles are ways to accomplish that:

  • All the user data sent by this frontend only ever goes to a single backend
  • 🔜 When data is cached on the local machine, it is encrypted with a user key
  • The repo uses TypeScript with a strict set of rules designed to reduce bugs closest to development
  • The code is continously scanned by a CI that runs CodeQL
  • Dependencies are kept to a minimum
  • When vulnerabilities are detected in dependencies they are auto updated with Dependabot

🚀 Installation

This app is meant to be self-hosted by individuals and groups who wish to own their data and those who prioritize their data privacy. For setup instructions check out the tasks-backend README.

🛠️ Development

🖥️ Devcontainer

A devcontainer configuration is set up in this repo to help jumpstart development with all the required dependencies available for both the frontend and backend. You can use this configuration alongside GitHub codespaces to jump into a remote development environment without installing anything on your local machine. For the best experience make sure your codespace has both repos cloned in it. Ports can be forwarded from within the container so that you are able to test changes locally through the VS Code tunnel.

📃 Requirements

  • NodeJS 20+
  • yarn

🔁 Inner loop

  1. Navigate to the root of the repo
  2. Ensure you have the latest packages installed with yarn install
  3. Run yarn start. The output will contain instructions on how to browse the frontend.
  4. Separately follow instructions from tasks-backend
  5. (optionally) If using a different host for the backend, update VITE_APP_API_URL in .env

🤝 Contributing

Contributions are welcome! If you would like to contribute to this repo, feel free to fork the repo and submit pull requests. If you have ideas but aren't familiar with code, you can also open issues.

🔒 License

See the LICENSE file for more details.

About

Task Wizard Frontend

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages