From 35cac6560bee60e38e1a9cf910726ca02ef6a50a Mon Sep 17 00:00:00 2001 From: cws Date: Sun, 2 Feb 2020 13:41:33 +0100 Subject: [PATCH] spell check passed --- README.md | 8 ++++---- README.md.bak | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 4 deletions(-) create mode 100644 README.md.bak diff --git a/README.md b/README.md index c02af92..1b38bb6 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ EMAIL_FROM = noreply@your-blog.com EMAIL_TO = your@email.com ``` -Additionally, you can add a port vairable `PORT = `, if you want to change thedefault port `7000` to something else. +Additionally, you can add a port variable `PORT = `, if you want to change the default port `7000` to something else. ## Usage @@ -47,7 +47,7 @@ You should see the message `Listening on http://localhost:7000`. ## Deploy (More detailed info in the tutorial) - copy the work folder `ghost-contact-form` to your server -- use `ghost-contact.service` as a starting point for running `ghost-contact-svc.js` as a systemd deamon -- configure your webserver to map endpoint `http://localhost:7000/` to a public endpoint, e.g. `https://api.your-blog.com/` +- use `ghost-contact.service` as a starting point for running `ghost-contact-svc.js` as a systemd daemon +- configure your web-server to map endpoint `http://localhost:7000/` to a public endpoint, e.g. `https://api.your-blog.com/` - Use the files in folder `ghost-admin` to configure your Ghost front-end -- Other front-end config files upon request! +- Other front-end configuration files upon request! diff --git a/README.md.bak b/README.md.bak new file mode 100644 index 0000000..c02af92 --- /dev/null +++ b/README.md.bak @@ -0,0 +1,53 @@ +# ghost-contact-form +Add a beautiful, fully functional contact form to your Ghost blog or website without paying for external services. + +*Not running on Ghost?* This solution also works with Gatsby, Hugo, Hexo, Nuxt and any other static site generator. + +## Tutorial +- [Contact Forms in Ghost](https://atmolabs.org/contact-forms-in-ghost/) + +## Prerequisites +- A supported version of Node.js +- npm to manage packages + +## Quickstart Install + +``` +$ git clone https://github.com/styxlab/ghost-contact-form.git +$ cd ghost-contact-form +$ sh install.sh +``` + +## Configure + +Adapt the `.env` file to your needs. The following variables must be defined. + +``` +SMTP_HOST = mail.server.com +SMTP_USER = user@server.com +SMTP_PASS = strong password +ALLOW_ORIGIN = https://your-blog.com +EMAIL_FROM = noreply@your-blog.com +EMAIL_TO = your@email.com +``` + +Additionally, you can add a port vairable `PORT = `, if you want to change thedefault port `7000` to something else. + +## Usage + +``` +$ node ghost-contact-svc.js +``` +You should see the message `Listening on http://localhost:7000`. + +## Test Locally + +[http://localhost:7000/v1/demo](http://localhost:7000/v1/demo) + +## Deploy (More detailed info in the tutorial) + +- copy the work folder `ghost-contact-form` to your server +- use `ghost-contact.service` as a starting point for running `ghost-contact-svc.js` as a systemd deamon +- configure your webserver to map endpoint `http://localhost:7000/` to a public endpoint, e.g. `https://api.your-blog.com/` +- Use the files in folder `ghost-admin` to configure your Ghost front-end +- Other front-end config files upon request!