Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amn41 authored Jul 29, 2024
1 parent 00f2f0b commit 5188460
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,46 @@
# codespaces-quickstart
Get started with Rasa Pro in the browser using GitHub Codespaces.

### Steps

1. **Create a Codespace:**
- Click on the green "Code" button on this page, then scroll down to "Codespaces".
- Click on "Create codespace on main".

2. **Set Up Environment:**
- Open the `.env` file from this repo and add the required keys to that file.
```
export RASA_PRO_LICENSE='your_rasa_pro_license_key_here'
export OPENAI_API_KEY='your_openai_api_key_here'
```
- Set these environment variables by running `source .venv/bin/activate`
```
source .env
```
- Activate your python environment by running
3. **Initialize a New Project:**
- In the terminal, run:
```
rasa init --template tutorial
```
and follow the instructions.
4. **Train the Model:**
- In the terminal, run:
```
rasa train
```
5. **Talk to your Bot:**
- In the terminal, run
```
rasa inspect
```
GitHub will show a notification, click on the green button to view the inspector where you can chat with your assistant.
6. **Run Custom Actions:**
If your bot uses custom actions, you will need to run an action server. To do this:
- Create a secnd terminal window in the codespace
- load the env vars and activate your virtual environment: `source .env && source .venv/bin/activate`
- start the action server by running `rasa run actions`

0 comments on commit 5188460

Please sign in to comment.