You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,19 @@
2
2
3
3
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.
4
4
5
+
> [!NOTE]
6
+
> **Before Submitting**
7
+
>
8
+
> Check if there are other similar [PRs](https://github.com/weaponsforge/send-email/pulls).
9
+
>
10
+
> **New Feature**
11
+
>
12
+
> 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.
13
+
>
14
+
> **Bug Fixes**
15
+
>
16
+
> Provide a detailed description of the bug (with live demo if possible). OR open a bug report and link it in your PR.
17
+
5
18
## Getting Started
6
19
7
20
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.
@@ -64,4 +77,4 @@ Welcome to the **send-email** repository! We're excited to have you contribute
64
77
65
78
4.**Respect:** Respect the structure and formatting of the existing project. Follow the standard ESLint rules defined in its `app/eslint.config.mjs` file.
66
79
67
-
Thank you for contributing to the **send-email** repository. Your efforts help in sending emails more accessible for everyone.
80
+
Thank you for contributing to the **send-email** repository. Your efforts help in making sending emails more accessible for everyone.
Copy file name to clipboardExpand all lines: README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ NPM library and CLI for sending text and HTML emails using Gmail SMTP with Googl
39
39
```text
40
40
Recommended:
41
41
node: 24.11.0
42
-
npm: 10.9.2
42
+
npm: 11.6.1
43
43
```
44
44
3. Gmail Account
45
45
- 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)
@@ -72,6 +72,7 @@ We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) and the
72
72
- See **Installation # 4** for more information about these environment variables.
73
73
2. Install dependencies.
74
74
```bash
75
+
cd app
75
76
npm install
76
77
```
77
78
3. Transpile to JavaScript.
@@ -184,7 +185,7 @@ We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) and the
184
185
docker run -it -v ${pwd}/app:/opt/app -v /opt/app/node_modules --rm weaponsforge/sendemail:dev <AVAILABLE_SCRIPT_OR_DOCKER_SCRIPT>
185
186
```
186
187
187
-
-**Run a non-test TS file using Vite**<br>
188
+
-**Run a non-test TS file using TypeScript Execute (tsx)**<br>
188
189
(requires **Run an NPM script using Docker compose**)
Copy file name to clipboardExpand all lines: docs/README_NPM.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,12 +29,14 @@ NPM library for sending text and HTML emails using Gmail SMTP with Google OAuth2
29
29
```text
30
30
Recommended:
31
31
node: 24.11.0
32
-
npm: 10.9.2
32
+
npm: 11.6.1
33
33
```
34
34
2. Gmail Account
35
35
- 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)
36
36
- Read on the Google [Gmail](https://developers.google.com/gmail/api/guides), [SMTP and OAuth2 Setup](https://github.com/weaponsforge/email-sender?tab=readme-ov-file#using-the-oauth-20-playground) sections for more information
37
37
38
+
3. A `.env` file containing the environment variables described under **Quickstart - step #2**.
0 commit comments