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

  1. Ensure you have NodeJS 20+ installed
  2. Clone the repository:
  3. Navigate to the project directory: cd path/to/cloned/repo
  4. Download dependency yarn install
  5. Run locally yarn start. The output will contain instructions on how to browse the frontend.
  6. Separately run the backend using instructions from tasks-backend
  7. (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, please follow these steps:

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes and commit them: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/your-feature-name
  5. Submit a pull request

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