https://github.com/fbn776/assistant
A chatbot like application; but with a custom command line language backed up by JavaScript
https://github.com/fbn776/assistant
assistant chatbot typescript
Last synced: about 1 year ago
JSON representation
A chatbot like application; but with a custom command line language backed up by JavaScript
- Host: GitHub
- URL: https://github.com/fbn776/assistant
- Owner: fbn776
- Created: 2023-08-27T19:16:52.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-21T16:55:22.000Z (over 2 years ago)
- Last Synced: 2025-06-07T09:05:44.613Z (about 1 year ago)
- Topics: assistant, chatbot, typescript
- Language: TypeScript
- Homepage: https://assistant-ebon.vercel.app
- Size: 306 KB
- Stars: 11
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Assistant ✨
The Assistant is a personal project for learning and experimenting with `typescript`. The project is a chatbot like application that responds to user given commands. These commands are defined using a custom built instruction language. The commands can be chained together to create more complex instructions. These are then executed by a custom executor, and the results are returned to the user via messages in the chat.
## Usage
The web application is hosted [here](https://assistant-ebon.vercel.app/). Once opened, you can type commands. Currently [^date] there are only a few commands supported.
Assistant is like a interpreter, it takes in string of text, via the text box and interprets the result and displays the result.
The language assistant interprets is called `AssistScript`
Read more about it [here](./docs/Language/lang.md).
Eg:
```
add 10 20
```
Outputs 30
NOTE: More documentation is needed
## Workings
TODO; This section is incomplete and will be updated soon.
Try reading
- [controllers and handlers](./docs/What%20are%20controller%20and%20handlers.md)
## Tech stack
- ReactJS
- Typescript
- Tailwindcss
- Vite
## Local installations
git clone/download this project, then open the terminal and cd into this project. Then in the terminal run;
```bash
npm install
npm run dev
```
## TODO
- [ ] Documentations
- [ ] Keyboard controls
- [ ] Better command parsing
- [ ] More commands
- [ ] Better desktop UI
- [ ] Refactors
[^date]: Last updated at 19/11/2023