README.md

Timetender v0.1.4

1 Description

During my high school, I use Excel as a todo list to manage my tasks such as homework. It's time to make a more powerful version by React.

It follows these rules:

• x-axis is the calendar (each column is a date), so it's infinite
• y-axis is task list (each line contain only one task), expanding

And with classifying by color and tags, it can be more powerful.

1.1 (eliminated) Excel Concept

1.2 Now Project

2 Usage

# DockerHub
docker pull titanrgb/timetender:latest
# GitHub
docker pull ghcr.io/mehver/timetender:latest
# Quay.io
docker pull quay.io/titanrgb/timetender:latest

docker run -d \
  --name=timetender \
  -e TZ=Asia/Shanghai \
  -p 127.0.0.1:80:8080/tcp \
  -v /path/to/config:/usr/lib/timetender/config \
  -v /path/for/data:/usr/lib/timetender/data \
  titanrgb/timetender:latest

Parameter	Function
-p 127.0.0.1:80:8080/tcp	Http webUI
-e TZ=Asia/Shanghai	Specify a timezone
-v /path/to/config:/usr/lib/timetender/config	Timetender's configuration directory
-v /path/for/data:/usr/lib/timetender/data	Timetender's data storage directory

3 Development

Requirements

• Node.js v16.16.0
• Docker v20.10.17

Install Dependency

npm install --legacy-peer-deps
npm run build

Frontend Development

npm run react

Frontend Compile

npm run build

Backend Server

npm start

Build Docker Image

npm install --legacy-peer-deps
npm run build
docker build -t <YourID>/timetender:<tag> .

4 Built With

• Node.js
  • React.js
    • Luckysheet (https://github.com/mengshukeji/Luckysheet)
    • Material UI (https://github.com/mui/material-ui)
    • Ant Design (https://github.com/ant-design/ant-design)
    • Json Editor (https://github.com/josdejong/jsoneditor)
  • Express.js
• Docker
  • Node.js v16 Image (https://hub.docker.com/_/node)
    • node:16-alpine3.16

5 Reference

• GitHub@mengshukeji/Luckysheet
  • https://dream-num.github.io/LuckysheetDocs/zh/guide/config.html
  • https://dream-num.github.io/LuckysheetDocs/zh/guide/api.html
• GitHub@mengshukeji/luckysheet-react
• GitHub@mui/material-ui
  • https://mui.com/zh/material-ui/react-table/
• GitHub@ant-design/ant-design
  • https://ant.design/components/icon/
• GitHub@josdejong/jsoneditor
  • https://github.com/josdejong/jsoneditor/tree/master/examples/react_demo

6 License

MPL 2.0

Copyright © 2022-PRESENT GitHub@Mehver/Timetender , All Rights Reserved.