Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize project #42

Merged
merged 1 commit into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ on:
jobs:
build-and-test:
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./apps/bot
strategy:
matrix:
node-version: [18.x]
Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Follow these steps to set up and run your bot using this repository:
After cloning the repository, navigate to the `web-app` directory:

```bash
cd web-app
cd apps/web-app
```

Run the following command to build the web app:
Expand All @@ -49,7 +49,7 @@ Follow these steps to set up and run your bot using this repository:

This command will generate build output resources inside the `dist` directory. You can now deploy these resources as a regular static website to your hosting provider of choice.

For information on launching the web app in developer mode, please refer to [web-app/README.md](./web-app/README.md)
For information on launching the web app in developer mode, please refer to [apps/web-app/README.md](./apps/web-app/README.md)

3. **Configure the Menu Button**

Expand All @@ -61,12 +61,16 @@ Follow these steps to set up and run your bot using this repository:

**Congrats!** Web App is deployed and available to bot users.

> **Note**
> The previous steps are focused on deploying web app. If your goal is to have a fully functional bot that also operates within a chat interface, follow the steps below.
> [!NOTE]
> At this stage web app is fully functional, further steps are optional.

4. **Environment Variables Setup**

Once you have completed the web app build and deployment, return to the project's root directory.
Once you have completed the web app build and deployment, navigate to the `apps/bot` directory:

```bash
cd ../bot
```

Create an environment variables file by copying the provided example file:
```bash
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading