Code Monkey home page Code Monkey logo

task_diary's Introduction

Task Diary

An app to record daily planned/ completed tasks to help with evaluating personal performance.

See https://eriwang.github.io/task_diary/ for a demo version of the application. Note that this is just a demo mode, and will not save your changes.

screencap

First Time Setup

  • You should have python3 (3.6+), node, and npm installed.
  • Run scripts/setup.sh from repo root.
    • This will install all node/ python dependencies, and create a Python virtualenv.
    • This will also install git hooks, which do style checks for the repo.

Running the Server in a Development Environment

Development Mode

Do the following from repo root:

  • Activate your virtualenv
  • Run python backend_src/app.py
  • Run npm run run-dev

Flask and webpack will continue to monitor changes to files as long as the commands are running.

Demo/ Mock Mode

This mode will create a static version of the site where all the API calls are changed to function calls to a "dummy" backend. This is meant to be used for testing as well as demonstration purposes.

Do the following from repo root:

run-dev-mock will continue to monitor file changes as long as it is running.

Note that there is also a package-mock target: this just builds the mock mode and puts the files in docs/. This is meant to be used for the GitHub pages site, which is released from release/github_pages_site.

Deployment

Do the following from repo root:

  • Activate your virtualenv
  • scripts/build_prod.<bat|sh> (depending on file system)

This will create a single executable that bundles the Flask server and the HTML/ CSS/ JS. Run this executable normally, and go to the localhost URL shown in the command prompt popup to use the site.

Credits

SVG for all icons used taken from https://feathericons.com/.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.