Code Monkey home page Code Monkey logo

scrapbook's Introduction

Scrapbook

  • Scrapbook is a way to journal your goals, challenges, solutions and more, on a daily basis, which I guess is aimed to simplify tracking what you do everyday (kinda like note taking really)
  • I wanted a simple way of logging what I do everyday on my terminal (without really installing/opening other note taking apps), hence the script.

What it does:

  • The script generates a markdown document with a bunch of pre-coded headers such as "Challenges", "Project Overview", "Tasks" etc
    • The idea is to structure my notes everyday, as I tend to have random headings or sometimes (well a lot of times) I don't really log much of what I do.
  • It prompts the user to enter points for a specific sub-heading (such as tasks).
  • Once done, a markdown is generated in the dev-logs directory in your current working directory.

Functionality:

  • Generates markdown doc of everyday notes.
  • Simple structure.
  • Easy way to filter through your notes everyday using unix tools.

Limitations:

  • Hard coded markdown headers in the code.
  • Generate only once per day.
    • If you attempt to run it more than once, it will still work, it just appends it to the same log file (all the headers).
  • No flexibility to add more headers/remove headers at the moment.

Ideas/Potential solutions:

  • Make it config friendly, i.e enable the user to create a config file which will influence the behavior of the tool.

    • This can be used to customise the structure of the log file.
    • Generate a sample config template (a default one).
    • And potentially other things (idk right now).
  • Create installation script for tool. Make it system-wide (?).

  • Enable users to edit current log file for the day or create a new log file for the day.

  • Provide option flags for user to customise specific parts of the log file once generated.

    • If you've already generated one for the day and you've only filled out the task bit:
      • Provide user with options on what to modify/change?
      scrapbook -c "Learnings"
      • where -c is change.
      • This will change/modify the Learnings section.
    • Provide prompt for user when a log file for the day has already been generated:
    scrapbook 
    You've already generated a log file for the day, would you like to edit the current log file or generate a new one?
    
  • Provide default values for certain headers:

    • Project Name is most likely to remain same for a couple days/weeks/months.
    • Makes it easier for the user to skip through things.
  • Put in a help function for users.

  • Directory specific config (i.e change path names etc)

    • Hierarchical config files, so having a config file in the current directory will override the base config.
    • This is probably useful if you have multiple projects and want to manage how the directory, structure of the logs will look like per project.

scrapbook's People

Contributors

velvetsymphony avatar

Watchers

 avatar

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.