-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0366405
commit e91817f
Showing
2 changed files
with
48 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,9 +2,50 @@ | |
|
||
The AI chatbot will be white-labeled, allowing for full customization to meet the needs of any company. The chatbot will be integrated with Facebook Messenger, WhatsApp, and a custom chat window that can be embedded into company websites. | ||
|
||
Useful Resources and Links | ||
## Built with | ||
[![React][react-shields]][react-url] [![Vite][vite-shields]][vite-url] [![Typescript][typescript-shields]][typescript-url] | ||
|
||
* Board board: https://github.com/orgs/toggle-corp/projects/36 | ||
* Timeline: | ||
* Figma: | ||
* Local Deployment: | ||
## Getting started | ||
|
||
Below are the steps to guide you through preparing your local enviroment for the AI CHATBOT CMS. Before diving into setup please look into the concept of [Github Sub Modules](https://github.blog/open-source/git/working-with-submodules/), [Docker Merge](https://docs.docker.com/compose/how-tos/multiple-compose-files/merge/). | ||
|
||
### Prerequisites | ||
|
||
To begin, ensure you have network access. Then, you'll need the following: | ||
1. [Git](https://git-scm.com/) | ||
2. [Node.JS](https://nodejs.org/en/) version >=18 / 20+ | ||
3. [Pnpm](https://pnpm.io/) | ||
4. Alternatively, you can use [Docker](https://www.docker.com/) to build the application. | ||
|
||
### Local development | ||
|
||
1. Clone the repository using HTTPS, SSH, or Github CLI | ||
```bash | ||
git clone https://github.com/toggle-corp/ai-chatbot-cms.git #HTTPS | ||
git clone [email protected]:toggle-corp/ai-chatbot-cms.git #SSH | ||
gh repo clone toggle-corp/ai-chatbot-cms #Github CLI | ||
``` | ||
2. Download the contents of backend(ai-chatbot-backend) | ||
```bash | ||
git submodule update --init --recursive | ||
``` | ||
3. Update Environment variables | ||
Copy env.example to .env and update the variables for the cms | ||
```bash | ||
cp env.example .env | ||
``` | ||
Copy env.example to .env and update the variables for the backend | ||
```bash | ||
cd backend | ||
cp env.example .env | ||
``` | ||
> NOTE: Precidency level of backend is higher then CMS so you can add environment variables of backend in CMS but you have to create .env file in backend | ||
4. Build the docker image | ||
```bash | ||
docker compose build | ||
``` | ||
5. Start the development server | ||
```bash | ||
docker compose up | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters