![Mailvala](https://raw.githubusercontent.com/ramveer-jat/public-assets/main/logo.png)

# Mailvala

This is an email management tool, used for sending bulk emails quickly.

## Requirements

Below requirement must be fulfill in order to run the project successfully.

- Nodejs version requires ^18.16.0
- Database: MongoDB v6.0.0
- NPM

## Installation

1. Install the repository globally.

```bash
npm install -g mailvala
```

2. To run the library open the terminal and run below command.

```bash
mailvala
```

3. Open the shown URL in browser.

```bash
http://localhost:8000
```

## Change the environment settings

You can customize the application's configuration by modifying the `.env` file. Available configuration options include:

- Database connection settings
- Project PORT
- Application URL

#### Please follow below steps to update env file.

```bash
npm root -g
```

Above command will show the package installation path to you. Copy that path and add the package name on that path same like below example:
**In Windows :-** C:\Users\<username>\AppData\Roaming\npm\node_modules\mailvala
**In macOS/Linux :-** /usr/local/lib/node_modules/email-shortcut/mailvala

```bash
cd toThePath
```

**In Windows :-**

```bash
notepad .env
```

**In macOS/Linux :-**

```bash
nano .env
```

Then save the file & close the instance if you already running the project, then restart is by running bellow command.

```bash
mailvala
```