Skip to content

Latest commit

 

History

History
298 lines (204 loc) · 7.5 KB

BADSENDER.md

File metadata and controls

298 lines (204 loc) · 7.5 KB

Badsender email builder

Heroku server configuration

buildpack

In order for the image resize & the templates' preview generation to work you will need those build packs IN THAT ORDER:

Copy and paste those urls in the Buildpacks section of Settings

This has to be done BEFORE any deploy

configuring environments variables

  • go in the settings of your application
  • click on settings
  • click on Reveal Config Vars
  • variables name should follow this pattern :
badsender_emailOptions__from
  • always put badsender_ first
  • then each level of config should be seperate with a double underscore: __
  • see .badsenderrc-example on the master branch for the config requirements

below are the common environments variables you should want to set:

Mail sending

badsender_emailTransport__service         Mailjet
badsender_emailTransport__auth__user      your Username (or API key)
badsender_emailTransport__auth__pass      your password (or Secret Key)

badsender_emailTransport__service is for nodemailer-wellknown configuration

from email adress

badsender_emailOptions__from              Badsender Builder <[email protected]>

MongoDB database

the path to your mongoDB instance

badsender_database                        mongodb://localhost/badsender

Admin password

badsender_admin__password                 a password of your choice

Hostname

The domain name of your app

badsender_host                            badsender-test.herokuapp.com

AWS S3

Those are the keys you should set for aws

badsender_storage__type                   aws
badsender_storage__aws__accessKeyId       20 characters key
badsender_storage__aws__secretAccessKey   40 characters secret key
badsender_storage__aws__bucketName        your bucket name
badsender_storage__aws__region            region of your bucket (ex: ap-southeast-1)
getting AWS id

console.aws.amazon.com/iam -> create new access key

creating the bucket

console.aws.amazon.com/s3 -> create bucket

you have also to set the good policy for the bucket:

Properties -> Permissions -> Add bucket policy

and copy and paste this:

{
	"Version": "2008-10-17",
	"Statement": [
		{
			"Sid": "AllowPublicRead",
			"Effect": "Allow",
			"Principal": {
				"AWS": "*"
			},
			"Action": "s3:GetObject",
			"Resource": "arn:aws:s3:::YOURBUCKETNAME/*"
		}
	]
}

then replace YOURBUCKETNAME by your real bucket name

Other config

// will print on the front some debug infos
debug:          false,
// redirect any http request to https
forcessl:       false,
images: {
  // needed only if not using S3 image storage
  uploadDir:    'uploads',
  // tmp directory name for image upload
  tmpDir:       'tmp',
  // cache resized images & add cache-control to image request
  cache:        false,
},

Dev prerequisite

You need to have:

  • clone/fork the project
  • in your terminal, go in the folder
  • run npm run deps in the root folder

Updating the code

It should have a default config for dev already setup.
If you want to change some, create .badsenderc at the root of the project then fill with the values you want to overrride as described in the .badsenderrc-example

those are the main developper commands:

Build the project for production

npm run build

Start a server configured for production

npm start

server will be running on localhost:3000

Build and start a production server

npm run prod

Build and start a development server

npm run dev
  • server will be running on localhost:7000
  • server will be restarted on files changes
  • build will be updated on files changes also

Make a release

on your current branch

npm run release

The release will be pushed in the branch you have chosen (dev/stage)
Automatic deploy is configured in heroku. So pushing to any branch will automatically been deployed to heroku

Generating templates preview images

see README.md

Databases scripts

.badsenderrc should be provided with dbConfigs infos. See .badsenderrc-example for more informations

sync-db

  • can copy one DB into another
  • can also copy a snapshot saved in images.tmpDir (see below) into another
npm run sync-db

backup-db

  • will save a snapshot of the specified DB in the folder defined by images.tmpDir config
npm run backup-db

local-db

  • save a local db snapshot
  • restore it later
npm run local-db

Tests

Run all backoffice's tests:

  • Open a working dev server npm run dev
  • run the test with npm run tape

Run a specific test:

./node_modules/.bin/tape tests/functional/user-deactivation.js | ./node_modules/.bin/faucet

S3 notes

This is some script to backup a bucket or sync a bucket from a backup.
This is mostly use for developement purpose.

requirements

  • aws cli – brew install awscli on a mac
  • .badsenderc filled with s3Configs parameters. See .badsenderrc-example

more details about why we use the aws cli

backing up to a local folder

npm run backup-s3

syncing a bucket from a local folder

npm run sync-s3