Dear friends,
This repo has been the subject of many YouTube series tutorials, including:
- Building a Modern-Day CMS using NodeJS, AngularJS, MySQL
- Metabase Data Visualization
- Using Intercom.io As Your CRM
- Deploying to Heroku
Table of Contents for this Repo:
- Technologies Overview
- Getting Started
- Deployment with Heroku
- Intercom.io Integration
- Automated Email Integration
- License
The project includes a long list of technologies, including:
The easiest way to get started is to clone the repository:
# Get the latest snapshot
git clone https://github.com/ElishaKay/MySQL-Node-Angular
# Change directory
cd MySQL-Node-Angular
# Install NPM dependencies
npm install
# Or, if you prefer to use `yarn` instead of `npm`
yarn install
Next, we need to set up our MySQL Database.
Step 1: Using Xampp, or any other MySQL Client, create a database - with any name.
Step 2: Import the 'database.sql' file into your database - or just copy-paste that text into your SQL Command Query Runner. That will create the neccessary tables for the app to work.
Step 3: Add a .env file to your root directory that includes MySQL and Mailgun Email Creds - should look like this (the Mailgun and Second database Creds are optional - if you want to set up automated emails based on clients that match specific criteria:
HOST=the.ip.goes.here
DATABASE=yourdbname
USER=username
PASSWORD=thepassword
MAILGUN_USER=user@subdomain.domain.com
MAILGUN_PASSWORD=longhashpassword
HOST2=the.ip.goes.here
DATABASE2=yourseconddbname
USER2=username
PASSWORD2=thepassword
Once, you've achieved that, Then simply start your app
node server.js
or:
nodemon server.js
Note: I highly recommend installing Nodemon.
It watches for any changes in your node.js app and automatically restarts the
server. Once installed, instead of node app.js use nodemon app.js. It will
save you a lot of time in the long run, because you won't need to manually
restart the server each time you make a small change in code. To install, run
sudo npm install -g nodemon.
You can view our YouTube Tutorial Series on deploying this app to Heroku.
Once you are ready to deploy your app, you will need to create an account with a cloud platform to host it. These are not the only choices, but they are my top picks. From my experience, Heroku is the easiest to get started with, it will automatically restart your Node.js process when it crashes, zero-downtime deployments and custom domain support on free accounts.
- Download and install Heroku Toolbelt
- In terminal, run
heroku loginand enter your Heroku credentials - Follow the instructions within the Heroku Admin Dashboard - the list of commands is neatly written out there for you.
- Lastly, do
git push heroku master. Done!
Note: To install Heroku add-ons your account must be verified.
Regarding the automated node-schedule features, you can upload the app to Heroku, and the automated emails will work - but you may have to pay to keep the app running full-time (i.e. pay for a 'dyno' - highly isolated Linux Process) so that your Heroku app is turned on when the scheduler reaches the Send-Time.
Intercom Integration is included: Define your currently-logged in User via the AngularJS run method.
This project is part of an Intercom Tutorial Series
Amongst the app's features is the ability to send automated emails with MySQL and Node, and includes an Angular front-end with EJS and UI-Router for a single-page-application experience.
The app also uses 'node-schedule' to automatically send the results of a MySQL database to your choice of email address[es].
The app is kind of like an email server - which allows you to send customized emails to your choice of clients. It runs on MailGun. So, you have to first create a Mailgun account.
Once you've done that, within your .env file, we give you the option to add 2 databases. The first database is the database that will hold all the information regarding your email server - the schedules for specific mails to go out, saved segments of users, and saved content for emails.
The second database connection is for the db that you want to segment your audience from and to pull data from for custom reports.
Regarding Node-Schedule, here's the syntax to control when emails get sent, or to defined other triggers based on a schedule.
* * * * * *
┬ ┬ ┬ ┬ ┬ ┬
│ │ │ │ │ |
│ │ │ │ │ └ day of week (0 - 7) (0 or 7 is Sun)
│ │ │ │ └───── month (1 - 12)
│ │ │ └────────── day of month (1 - 31)
│ │ └─────────────── hour (0 - 23)
│ └──────────────────── minute (0 - 59)
└───────────────────────── second (0 - 59, OPTIONAL)
The MIT License (MIT)
Copyright (c) 2014-2016 Sahat Yalkabov
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.