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.

Sign up for GitHub

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

Jump to bottom

chore: app installation docs #15

Merged
merged 1 commit into from
Oct 6, 2024
Merged

chore: app installation docs #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,23 @@ Frappe Mail is an open-source email tool built on the [Frappe Framework](https:/

You can install this app using the [bench](https://github.com/frappe/bench) CLI:

```bash
cd $PATH_TO_YOUR_BENCH
bench get-app $URL_OF_THIS_REPO --branch develop
bench install-app mail
```
1. Install Frappe Mail:

```bash
bench get-app mail
```

2. Create a site with the mail app:

```bash
bench --site sitename.localhost install-app mail
```

3. Open the site in the browser:

```bash
bench browse sitename.localhost --user Administrator
```

## Mail System Architecture

Expand Down