Skip to content
Open
Changes from 3 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
59 changes: 49 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="left">
<p align="left">
<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRpPlI1P7SK3pemg67VMPbvNzxYyk0UtlmJiQ&s" alt="Aossie Logo" height="120"/>
</p>

Expand Down Expand Up @@ -88,7 +88,7 @@ The server will start on the port defined in the config file (default: `1313`).
### Notes
- Do **not** commit `config.prod.yml` to version control.
- Only `config.prod.sample.yml` should remain committed.

`

### Frontend Configuration

Expand All @@ -97,8 +97,10 @@ The server will start on the port defined in the config file (default: `1313`).
2. Add the following environment variables to the `.env` file:

```
VITE_BASE_URL="http://localhost:1313"
VITE_GOOGLE_CLIENT_ID="<YOUR_GOOGLE_OAUTH_CLIENT_ID>"
VITE_BASE_URL=http://localhost:1313
VITE_GOOGLE_CLIENT_ID=<YOUR_GOOGLE_OAUTH_CLIENT_ID>

> **Note:** Do NOT wrap values in quotes. Restart frontend after changes.
```

- Replace `<YOUR_GOOGLE_OAUTH_CLIENT_ID>` with your actual Google OAuth Client ID from Google Cloud Console.
Expand All @@ -121,11 +123,7 @@ VITE_GOOGLE_CLIENT_ID="<YOUR_GOOGLE_OAUTH_CLIENT_ID>"
npm install
```

3. Create a `.env` file and add:

```
VITE_BASE_URL="http://localhost:1313"
```
3. See the earlier "Frontend Configuration" section for required environment variables.

4. Start the development server:
```
Expand All @@ -134,6 +132,45 @@ VITE_GOOGLE_CLIENT_ID="<YOUR_GOOGLE_OAUTH_CLIENT_ID>"

---

### Google OAuth Setup (Local Development)

1. Go to the [Google Cloud Console](https://console.cloud.google.com/).
2. Create a new project or select an existing one.
3. Enable the Google OAuth2 API.
4. Go to "Credentials" in the left sidebar.
5. Click "Create Credentials" > "OAuth 2.0 Client IDs".
6. Set Application type to "Web application".
7. In the "Authorized JavaScript origins", add:
- http://localhost:5173
- http://127.0.0.1:5173
- http://localhost:1313
- http://127.0.0.1:1313
8. In the "Authorized redirect URIs", add the same URLs as above.
9. Download the credentials JSON file and note your Client ID.
10. Exact match of URLs is required for proper functioning.

### Email Verification Setup (Gmail SMTP App Password)

For email verification functionality, DebateAI uses SMTP for sending emails. If using Gmail:

1. Enable 2-Factor Authentication on your Gmail account.
2. Go to Google Account settings.
3. Navigate to Security > 2-Step Verification > App passwords.
4. Generate a new app password for "Mail".
5. Use this app password in your SMTP configuration instead of your regular Gmail password.

Example SMTP configuration in config.prod.yml:
```yaml
smtp:
host: "smtp.gmail.com"
port: 587
username: "[email protected]"
password: "your-app-password-here"
senderEmail: "[email protected]"
```

> **Warning:** Never commit credentials to version control.

## Contribution Guidelines

Thank you for your interest in contributing to **DebateAI**! We appreciate your efforts in making this project better. Please follow these best practices to ensure smooth collaboration.
Expand Down Expand Up @@ -212,6 +249,8 @@ We look forward to your contributions!

## License

MIT © [AOSSIE](https://aossie.org)
MIT © [AOSSIE](https://aossie.org)

---
`