File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -22,37 +22,48 @@ Canis supports multiple AI providers out of the box:
2222- [ Gemini (Google)] ( https://ai.google.dev/gemini )
2323- [ Ollama] ( https://ollama.com/ )
2424
25- Configure your preferred provider in the ` .env ` file.
26-
2725## Prerequisites
2826
2927- Node.js (>=24)
30- - WhatsApp
28+ - MySQL
29+
30+ You can changed the db provider in ` prisma/schema.prisma `
31+
32+ - Redis/Valkey
33+ - WhatsApp Account
3134
3235## Getting started
3336
34- 1 . ** Clone repo**
37+ 1 . ** Clone repo**
3538
36- ``` bash
39+ ``` sh
3740 git clone https://github.com/mrepol742/project-canis.git
3841 cd project-canis
3942
43+ ```
44+
40452 . ** Install dependencies**
4146
42- ```
47+ ``` sh
4348 npm install
4449 ```
4550
46513 . ** Setup environment variables**
4752
48- ```
53+ ``` sh
4954 cp .env.example .env
55+ # Configure your AI Provider, models and other necessary preferences.
5056 ```
51- Edit .env with your WhatsApp credentials, DB connection, and other keys.
5257
53- 4. **Run**
54-
58+ 4 . ** Run Migration**
59+
60+ ``` sh
61+ npx prisma migrate dev
5562 ```
63+
64+ 5 . ** Start bot**
65+
66+ ``` sh
5667 npm run start
5768 ```
5869
@@ -65,26 +76,27 @@ Configure your preferred provider in the `.env` file.
6576 ```
6677
67782 . ** Run with Docker Compose**
68-
79+
6980 ```
7081 docker-compose up -d
7182 ```
7283
73843 . ** Run with expose port**
74-
85+
7586 ```
7687 docker run -d -p 3000:3000 project-canis
7788 ```
7889
7990#### PM2
8091
81921 . ** Build**
93+
8294 ```
8395 npm run build
8496 ```
8597
86982 . ** Start**
87-
99+
88100 ```
89101 cd dist
90102 pm2 start ecosystem.config.js
You can’t perform that action at this time.
0 commit comments