https://github.com/notsu/todos-nodejs
LINE BOT for helping people manage their todo list.
https://github.com/notsu/todos-nodejs
Last synced: 5 months ago
JSON representation
LINE BOT for helping people manage their todo list.
- Host: GitHub
- URL: https://github.com/notsu/todos-nodejs
- Owner: notsu
- Created: 2018-05-07T15:20:38.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T02:28:26.000Z (about 2 years ago)
- Last Synced: 2024-05-21T03:38:28.410Z (about 2 years ago)
- Language: JavaScript
- Size: 953 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LINE Todos
LINE BOT for helping people manage their todo list.
## Installation
1. Open LINE application.
2. Scan the following QR code to add bot as your friend
## Usage
### Create Task
Typing the following message pattern to create task
`{task} : {date} : {time}`
eg.
`Watch movie : 22/05/18 : 19:00`
`Watch movie : 22/05/18` -- default time will be `00:00` (12:00 PM)
The system also provide alias date as following
`Watch movie : Today : 20:00`
`Watch movie : Tomorrow`
Alias date list:
- Today
- Tomorrow
- Next week
- Next month
- Next year
### Update Task
Send "edit" message, system will send you a link to update task.
### Help
We provide information about how to use bot when you send a message `Help` or `ช่วยเหลือ`.
### Contribute
If you need to run this project in your local machine you need to following this step.
#### Prerequisite
- [Docker](https://www.docker.com/get-docker) for virtual environment for local machine.
- [ngrok](https://ngrok.com/) for expose your local machine to public when develop your bot.
#### Local development
1. Copy .env.example to .env
2. Setup your setting in .env
3. Run ngrok in separate terminal during development
4. Run `yarn migrate db:create todos`
5. Run `yarn migrate up`
6. Run `docker-compose up` at this folder to running docker for local development
PS. `Dockerfile` for deploy to any cloud such as Heroku, AWS, GCP, etc.