diff --git a/README.md b/README.md new file mode 100644 index 0000000..6106b71 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# mail-send-api + +## Project setup + + 1. download the project + +```SHELL +$ git clone https://github.com/rdornelles/mail-send-api +``` + + 2. Install dependencies + +```SHELL +$ npm install +``` + + 3. create `.env` in the root patch project + +```ENV +PORT = <80> +ORIGIN = +RECAPTCHA_KEY = +RECAPTCHA_URL = +MAIL_HOST = +MAIL_PORT = <586> +MAIL_SECURE = +MAIL_AUTH_USER = +MAIL_AUTH_PASS = <12435678> +TEXT_MAIL_TITLE = +TEXT_MAIL_BODY = +TEXT_MAIL_HTML = +TEXT_RESPONSE_OK = +TEXT_RESPONSE_FAIL_CAPTCHA = +``` + + 4. run project + +``` +npm run start +```