John-JonSteyn / TaskFlow

The Web-Based Task Manager. A simplistic, no-nonsense, Work Flow Manager you never knew you needed.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License


Logo

TaskFlow - The Web-Based Task Manager


The simplistic, no-nonsense, Work Flow Manager you never knew you needed.
View Source Code »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. The Basics of TaskFlow
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

About The Project

There are many to-do lists available on GitHub - possibly even more than the amount of django-based websites; however, this is mine. I wanted to create something simple, functional and aesthetic - and it seems that this is what my efforts have amounted to.

Features:

  • Add tasks to your to-do list; Ensuring you won't forget about one along the way.
  • Remove accomplished tasks; Remove clutter from your workflow
  • Add and view details; Including the date and time tasks were uploaded.
  • Edit tasks; Because details tend to change - even if the main idea stays the same.
  • Filter tasks; With so much on your plate, you really don't have to scroll through all of them in search of the task you need - urgently.
  • User authentication; Login is required to access any non-login site, script kiddies aren't going to mess with your day!
  • Simplicity is key; We live with enough distractions and adds - use an application that drops the unnecessary and helps you with your necessities.

(back to top)

Built With

(back to top)

Getting Started

Setting up TaskFlow on your local machine might sound daugnting, but not to fear - as long as README is here! Simply execute these simple steps, as you would on your to-do list.

Prerequisites

You'll need Python 3.8 or higher, as well as Django 4.0 or newer for the application to run smoothly. A virtual environment is not necessary, but advised. Therefore we'll cover its installation as well. Not installed? No worries, all you need is an internet connection.

Downloading the lastest version of Python:

  • Click here to navigate to python's official page.
  • Click on the big, round "Download Python [version]" button.
  • Save the executable file.
  • Open the .exe file within the downloaded location, and follow the installation instructions.

Downloading VirtualEnv (recommended):

  • Open the terminal / command prompt
    • On PC: Open Command prompt by pressing start, then typing "cmd" then hit ENTER.
    • On Mac OS: Click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal.
  • Type the following command to install VirtualEnv:
    pip install virtualenv

Downloading the lastest version of Django:

  • Open the terminal / command prompt (only if not already open)
    • On PC: Open Command prompt by pressing start, then typing "cmd" then hit ENTER.
    • On Mac OS: Click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal.
  • Type the following command:
    pip install django

Installation

  1. Navigate to the directory you would like to install TaskFlow:
cd [DirectoryPathHere]
  1. Clone the repository by entering the following command into your shell:
    git clone https://github.com/John-JonSteyn/TaskFlow.git
  2. Create a virutal environment by entetering the following command:
virtualenv taskFlowEnv
  1. Activate the virutal environment by entetering this command:
taskFlowEnv\script\activate
  1. Lastly, Make migrations with this command:
taskFlowEnv\script\activate

Running TaskFlow

  • Finally, we can run the server with this command:
    python manage.py runserver
  • Click Here or head to one of the following sites:
    http://127.0.0.1:8000/
    localhost:8000/

(back to top)

The Basics of TaskFlow

Registration

TaskFlow Registration If this is your first time using TaskFlow, you will automatically be redirected to the Registration page. Enter a username as well as a password that satisfies the minimum requirements.

TaskFlow Empty List No, you're not on vacation, you just haven't uploaded any tasks yet.

Add Tasks

Click on Add Tasks and fill in the task's title and a description thereof. The description isn't necessary, but could greatly help with more complex tasks - such as buying groceries. TaskFlow Add Task Click on the "Add Task" button to have it added to your list.

The Main View

TaskFlow List This is your very own list. Don't worry, no other user is able to view or manipulate it - only you can.

Viewing Task Details

If you've forgotton the minuce of a task, but remembered to add the details of it, you can click on "View Details" to help yourself out. TaskFlow Details

Deleting Tasks

From the main view, you can also click on "Delete" on an item to remove it. This will open a confirmation screen. Remember: If you delete it, we can't bring it back - so please be sure before confirming. TaskFlow Delete

Logging Out

If you click on "Logout", it would do just that. What a surprise!

Logging In

TaskFlow Login When you're good and ready, you can log back in to view your goals, then go crush them one-by-one.

(back to top)

Roadmap

  • Add Edit Task Mode
  • Add back to top links
  • Add Light Mode
  • Multi-language Support
    • Deutsch
    • Français
    • Português

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

I'd also like to acknowledge and recommend these resources that made the creation of this project significantly easier to tackle alone.

(back to top)

About

The Web-Based Task Manager. A simplistic, no-nonsense, Work Flow Manager you never knew you needed.

License:MIT License


Languages

Language:Python 52.1%Language:HTML 34.6%Language:CSS 13.3%