Skip to content
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ body:
label: To Reproduce
description: A step-by-step description of how to reproduce the issue, or a link to the reproducible repository.
placeholder: |
1. Start the application in development (`npm run sendemail:dev -- text -s "Title" -c "Sample body" -r a@gmail.com`)
1. Start the application in development (npm run sendemail:dev -- text -s "Title" -c "Sample body" -r a@gmail.com)
2. Press enter
3. An error appears: "[ERROR] Failed to send text email: Required clientId"
validations:
Expand Down
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

Welcome to the **send-email** repository! We're excited to have you contribute to sending text and HTML-format emails more accessible via command line interface (CLI). To ensure a smooth contribution process for everyone, please follow these guidelines.

> [!NOTE]
> **Before Submitting**
>
> Check if there are other similar [PRs](https://github.com/weaponsforge/send-email/pulls).
>
> **New Feature**
>
> Before submitting a new feature, please open a **Feature Request issue** that clearly explains the proposed functionality and the reasons behind it. Once the request has been reviewed and approved, you may proceed with submitting a pull request.
>
> **Bug Fixes**
>
> Provide a detailed description of the bug (with live demo if possible). OR open a bug report and link it in your PR.

## Getting Started

1. **Fork the Repository:** Start by forking the repository's `"dev"` branch to your GitHub account. This creates your own copy of the project where you can make changes.
Expand Down Expand Up @@ -64,4 +77,4 @@ Welcome to the **send-email** repository! We're excited to have you contribute

4. **Respect:** Respect the structure and formatting of the existing project. Follow the standard ESLint rules defined in its `app/eslint.config.mjs` file.

Thank you for contributing to the **send-email** repository. Your efforts help in sending emails more accessible for everyone.
Thank you for contributing to the **send-email** repository. Your efforts help in making sending emails more accessible for everyone.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ NPM library and CLI for sending text and HTML emails using Gmail SMTP with Googl
```text
Recommended:
node: 24.11.0
npm: 10.9.2
npm: 11.6.1
```
3. Gmail Account
- Google Cloud Platform project configured with [OAuth2](https://developers.google.com/workspace/guides/configure-oauth-consent) settings and [credentials](https://developers.google.com/workspace/guides/manage-credentials)
Expand Down Expand Up @@ -72,6 +72,7 @@ We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) and the
- See **Installation # 4** for more information about these environment variables.
2. Install dependencies.
```bash
cd app
npm install
```
3. Transpile to JavaScript.
Expand Down Expand Up @@ -184,7 +185,7 @@ We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) and the
docker run -it -v ${pwd}/app:/opt/app -v /opt/app/node_modules --rm weaponsforge/sendemail:dev <AVAILABLE_SCRIPT_OR_DOCKER_SCRIPT>
```

- **Run a non-test TS file using Vite**<br>
- **Run a non-test TS file using TypeScript Execute (tsx)**<br>
(requires **Run an NPM script using Docker compose**)
```bash
docker exec -it weaponsforge-sendemail-dev npx tsx /opt/app/src/<PATH_TO_TS_FILE>.ts
Expand Down Expand Up @@ -375,8 +376,8 @@ Sends text and HTML emails using the command line interface (CLI) with transpile
Options:
-s, --subject <title> email subject or title enclosed in double-quotes
-r, --recipients <emails> comma-separated list of email addresses
-c, --content <text...> whitespace-delimited of text/paragraphs enclosed in double-quotes
-w, --wysiwyg [html] optional HTML tags that form a WYSIWYG content enclosed in double-quotes
-c, --content <text...> whitespace-delimited text/paragraphs enclosed in double-quotes
-w, --wysiwyg [html] optional HTML tags that form a WYSIWYG content enclosed in double-quotes, using inline CSS styles
-e, --env [path] path to .env file (optional)
-h, --help display help for command
```
Expand Down
Loading
Loading