Workflows is an open source application that provides a frontend and backend to organize your day. The application is built using a monolithic architecture and utilizes the following technologies:
- Svelte Kit for building the frontend
- Prisma for managing the database
- PostgreSQL as the database system
- TypeScript as the programming language
To install and run Workflows on your local machine, follow these steps:
- Clone the repository
git clone https://github.com/edlingao/workflows.git
- Install dependencies:
cd workflows
npm install
- Apply database migrations:
npx prisma migrate dev --name init
- Start the development server:
npm run dev
Open your web browser and go to http://localhost:3000 to access the application.
Workflows provides the following features to organize your day:
Workflows implements a calendar to allow you to view your activities by day, week, and month.
The home page provides a view of all your activities for today and tomorrow. The activities for today are highlighted as time passes.
Workflows sends a notification when an activity is finished and the new one starts.
Tasks can be associated with a range of time and are included on the homepage. You have the option to mark them as done and they will disappear, or they can be persistent and bound to your time range.
If you would like to contribute to Workflows, please follow the steps below:
- Fork the repository to your own account.
- Clone the forked repository to your local machine.
- Create a new branch for your changes:
git checkout -b my-new-feature
- Make the necessary changes and commit them:
git commit -m "Add my new feature"
- Push your changes to your forked repository:
git push origin <username>/my-new-feature
- Create a new pull request to merge your changes into the original repository.