101 lines
3.2 KiB
Markdown
101 lines
3.2 KiB
Markdown
# Recurring Checklist Application
|
|||
|
|
|
||
|
|
A simple Windows desktop application for managing recurring checklists. Perfect for tasks that need to be completed on a regular schedule, similar to Planning Center checklists but dedicated and simplified.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- ✅ Add checklist items with titles and detailed descriptions
|
||
|
|
- ✅ Mark items as complete (moves to "Done" section)
|
||
|
|
- ✅ Set items to recur daily, weekly, or monthly
|
||
|
|
- ✅ Automatic reset of recurring items based on schedule
|
||
|
|
- ✅ Dark theme interface matching Planning Center style
|
||
|
|
- ✅ Card-based layout with clear visibility
|
||
|
|
- ✅ Data persistence across sessions
|
||
|
|
- ✅ Easy to package and distribute to multiple machines
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
### Development Setup
|
||
|
|
|
||
|
|
1. Install Node.js (if not already installed) - Download from [nodejs.org](https://nodejs.org/)
|
||
|
|
2. Navigate to the project directory:
|
||
|
|
```bash
|
||
|
|
cd recurring-checklist-app
|
||
|
|
```
|
||
|
|
3. Install dependencies:
|
||
|
|
```bash
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
4. Run the application:
|
||
|
|
```bash
|
||
|
|
npm start
|
||
|
|
```
|
||
|
|
|
||
|
|
### Building for Windows Distribution
|
||
|
|
|
||
|
|
To create a Windows executable installer:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm run build:win
|
||
|
|
```
|
||
|
|
|
||
|
|
This will create an installer in the `dist` folder that you can distribute to other machines. The installer will be named something like `Recurring Checklist Setup 1.0.0.exe`.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
1. **Add Tasks**:
|
||
|
|
- Enter a title (required) and optional description
|
||
|
|
- Descriptions support multiple lines and can include detailed instructions
|
||
|
|
- Click "Add Task" or press Enter
|
||
|
|
|
||
|
|
2. **Set Recurrence**:
|
||
|
|
- Check "Recurring Task" checkbox
|
||
|
|
- Select frequency: Daily, Weekly, or Monthly
|
||
|
|
- For weekly: Choose the day of the week (e.g., Sunday)
|
||
|
|
- For monthly: Choose the day of the month (1-31)
|
||
|
|
|
||
|
|
3. **Complete Tasks**:
|
||
|
|
- Check the checkbox next to an item to mark it complete
|
||
|
|
- Completed items automatically move to the "Done" section
|
||
|
|
|
||
|
|
4. **Recurring Reset**:
|
||
|
|
- Recurring items automatically reset based on their schedule
|
||
|
|
- Daily items reset each day
|
||
|
|
- Weekly items reset on their specified day
|
||
|
|
- Monthly items reset on their specified day of the month
|
||
|
|
|
||
|
|
5. **Delete Tasks**:
|
||
|
|
- Click the "Delete" button on any task to remove it permanently
|
||
|
|
|
||
|
|
## Recurrence Options
|
||
|
|
|
||
|
|
- **Daily**: Item resets every day at midnight
|
||
|
|
- **Weekly**: Item resets on a specific day of the week (e.g., every Sunday)
|
||
|
|
- **Monthly**: Item resets on a specific day of the month (e.g., day 1)
|
||
|
|
|
||
|
|
## Data Storage
|
||
|
|
|
||
|
|
All checklist data is stored locally on your machine using `electron-store`. Data persists between application sessions and is stored in your user data directory.
|
||
|
|
|
||
|
|
## Distribution
|
||
|
|
|
||
|
|
The built application can be easily copied to other Windows machines:
|
||
|
|
|
||
|
|
1. Build the installer using `npm run build:win`
|
||
|
|
2. Copy the installer file from the `dist` folder
|
||
|
|
3. Run the installer on each Windows machine where you want to use the app
|
||
|
|
4. Each installation will have its own independent data storage
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- Windows 7 or later
|
||
|
|
- Node.js (for development and building only)
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- The application checks for recurring items every minute
|
||
|
|
- Recurring items reset based on the current date/time
|
||
|
|
- Each machine will have its own separate checklist data
|
||
|
|
- The app uses a dark theme similar to Planning Center for better visibility
|
||
|
|
|