Skip to content

Latest commit

 

History

History
212 lines (151 loc) · 6.55 KB

README.md

File metadata and controls

212 lines (151 loc) · 6.55 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Timely

Free countdown app which helps you measure focus time.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Timely Screen Shot

Project idea came from not so popular apps to countdown time. I was searching the solution for myself to use it on mobile, desktop and tablet. I haven't found such a good product so I make an own little app to help me with measuring my focus time.

Now the app is public available and anyone can use it with or without an account.

If you just want to test the app how it looks after the log in but you don't want to register - below is a test user account you can use:

Login: user@domain.com
Password: password

Built With

Backend

  • Python
  • Flask (Flask, Flask-Mail, flask-marshmallow, Flask-Migrate, Flask-RESTful, Flask-SQLAlchemy, Flask-WTF)
  • pytest for unit and functional tests
  • Docker and Docker-Compose

Database

Frontend

Live demo

The live demo was deployed on Google Cloud Platform using App Engine and Cloud SQL.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Before installation make sure that you have installed Docker.

Installation

  1. Clone the repo

    git clone https://github.com/tomaszkyc/timely.git
cd timely
docker-compose up

  2. Go to address http://localhost:5001 and you will see a main page.

Usage

You can deploy the app locally on some server and use it internally in your home network.

Roadmap

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

Contributing

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

  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

License

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

Contact

For contact details please check my Github profile

Project Link: https://github.com/tomaszkyc/timely