Note: This is still a big work in progress!
Clist
TOC
- Description of Clist
- Server side
- List of current functionality
- WIP / Goals
- Function documentation
Description
Why is the npm package called cli-tasklist if it's called clist? Because the name clist is taken! Clist is a command line interface / application for creating to-do lists by communicating with a webhosted sql database. Why a CLI? I wanted to make something that would be fast, and wouldn't require much loading. Something that you could use inbetween git pushes to check on what you still need to get done, or after a break if you've forgotten what you're working on, even to start off the morning and get going quickly.
Server side
First off by default the program is set to a glitch hosted server with a simple sqlite database. The server file can be found on the github for this project located here. The file is named server.js, and you can make your own glitch hosted sql db pretty easily. It's free too! Or you can use it on your own server or however you like really, it's up to you. The server dependencies are as follows:
- Express
- sqlite3
- moment
- nodemailer
- node-schedule
Note If you do make your own sql db and want to use that instead, be sure to change the base URLs in index.js Also currently the server.js file is the only thing being used on glitch, I might make this a webapp at some point but currently I'm working on finishing everything else first.
Current Functionality
- Display to-do list items
- Add items to your list
- Update items in your list
- Remove items from your list
- Email your list to one or more person
- Displays time since, in days, an item was added to the list
Short-term larger scale goals
- Login system
- Daily email
Minor changes
- Display time remaining until due-date
- Display current time
- Display date item was added in time since column
- Get rid of username column from modify command
- Make email function more dynamic
- If user says yes to wanting to add more recipients, askes for how many more, and then does for i in num_of_recipients etc...
- Make a better "item has been received response"
Long term goals
- All in one bundle, download and becomes useable
- Users have separate to-do lists
- Maybe allow users to have more than one to-do list,
Functions
Show list items
clist sList is then printed to the console, in a table, certain values are highlighted for clarity.
Add item to list
clist a// User is then prompted with the following questions:"Name of item""Description of item""Due date: must be in mm/dd/yyyy format""Time since automatically generated"Item is then sent and added to list
Modify list item
clist m User then chooses item to be modified, then prompted to choose the column for said item they'd like to change, and finally prompted for the new value. Item is then modified in database
Delete list item
clist d//User then chooses item to be deleted.Item is then deleted from the database. ** Cannot be undone **
Email list items
clist eUser is prompted for email, and then asked if they'd to add more like more email addresses Entered recipients are then emailed the entire to-do list