@erutidians/auto-dop

Automation for creating markdown files for 100 Days of Productivity challenge.

This started as a challenge initially inspired by Alexander Kallaway's 100-Days-of-Code. More info about our own challenge can be found here

How to:

Setup

• Using our template repository

  • generate a template by simply clicking the generate button in here.

  • clone and go to your generated repository.

    $ git clone https://github.com/your-username/your-generated-repository.git

  • then install

    $ npm install

• Or manually, if you already have your own repository

  • install @erutidians/auto-dop

    $ npm install @erutidians/auto-dop

  • make sure you have this line to your package.json:

    "type": "module"

  • you can compare your package.json from ours in our template repository if you encounter some problems.

  • create an index.js and paste this template code:

    import { run } from '@erutidians/auto-dop';
    
    const user = {
      name: 'Palskie',      // change this to any name that you're comfortable with.
      github: 'plskz',      // your github username.
      start: '6/1/2022',    // the date that you will start this challenge (e.g. m/d/yyyy)
      round: 2,             // the round number you currently are in. (if omitted, defaults to 1)
    };
    
    run(user);

Use (Commands)

• creates today

  $ node index.js

• creates yesterday's

  $ node index.js prev

• creates tomorrow's

  $ node index.js next

• creates any date

  $ node index.js $date

  where $date can be any valid date format (e.g. mm/dd/yyyy or m/d/yyyy)

Contributing

Help is always welcome! Please head to CONTRIBUTING.md file to see how to get started.

Challengers

Note: if you want to add yourself here in the list, fork this repository and submit a PR and wait for it to be reviewed and merged. More details can be found at CONTRIBUTING.md so make sure to follow that or else your PR will be immediately closed.

auto-dop has been used by these amazing challengers, check out their glorious journeys:

• yrnmsk
• plskz