Software Engineering Project
- Make sure git is installed on your system. If you type "git" into your command line/terminal and you don't get a reference for git commands, take these steps to install git:
https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
- Make a GitHub account
- Follow this guide to generate a key so you have access to GitHub repositories through git:
https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/
-
While logged in to your account, navigate to the original repository page (https://github.com/jharvey8/SoftwareEngineering)
-
Press the "fork" button on the upper right. This will create a copy of the repository under your own repositories.
-
Open a command line/terminal. Navigate to the directory you want this repository to be downloaded to, and type:
git clone [email protected]:[Your GitHub username here]/SoftwareEngineering
-
Enter the project directory in your command line/terminal.
-
To connect your local repository to the original on GitHub that it was forked from, type:
git remote add jharvey git://github.com/jharvey8/SoftwareEngineering
- Every time you sit down to start making changes, you should pull from the original repository's master branch to make sure you are up to date before starting your work:
git pull jharvey master
- Then, you should push any updates to your own online repository:
git push
- Make your changes. Add and commit them each time:
git add -A
git commit -m "[short description of the changes here]"
- At your discretion, push your changes to your online repository:
git push
- When you want to request that your changes be added to the original repository, you must make a pull request. This process is documented here:
https://help.github.com/articles/creating-a-pull-request-from-a-fork/
John is the repository owner and is currently responsible for handling these pull requests, so make sure to communicate with him when you send one.
### Initializing Application
- If you don't already have it, download and install Node.js https://nodejs.org/en/
This will give you Node Package Manager as well, which we will be using over the course of this project.
-
In the command line/terminal, navigate to the SoftwareEngineering/GhoulAlert directory
-
Initialize the application with the following command:
node app.js
Open a browser and navigate to http://localhost:3000 to access the web view of the application.
Node package manager helps us to install packages among different environments that will help us to accomplish various features, including database support and object relations. Some important points:
-
The project itself is in the GhoulAlert directory. npm commands will not work if you use them from the SoftwareEngineering directory.
-
Every time you pull from a remote repository or install new packages, run the following command:
npm install
This will install every dependency locally. This is important to do, as you will not receive the modules themselves from a pull.
- To install a package to the project, use the command:
npm install [package]
If you find a package online, it will usually tell you what keyword you need to use in the place of [package] to install it, and any command line options you can use to modify the installation.
- To install a package to your own machine (globally) instead of the project itself, use the same command but with the following option:
npm install [package] -g
You will usually only want to do this with special packages that generate or compile code, etc.
-
In the command line/terminal, navigate to the SoftwareEngineering/GhoulAlert directory
-
Run the application with one of the following commands:
Has no debug console. Will not refresh the server on changes.
npm run start
Has debug console. Will not refresh the server on changes.
DEBUG=ghoulalert:* npm run start
Has no debug console. Uses the nodemon package to refresh the server on changes.
npm run devstart
Has debug console. Uses the nodemon package to refresh the server on changes. This is the most useful option for development.
DEBUG=ghoulalert:* npm run devstart
This program can now connect to a MySQL database using the Sequelize module as an ORM (Object Relational Mapping Tool).
In order for the connection to be established, the database it is expecting needs to actually exist.
-
First, follow the instructions to install the MySQL Community Server: https://dev.mysql.com/downloads/mysql/
-
Next, you will want to install the MySQL Workbench to help you manage the server more easily: https://dev.mysql.com/downloads/workbench/
-
When you open the workbench, under MySQL connections there will be a local instance. This is what we will be working with, so open it.
-
In the left panel in the Administration tab, there will be an icon for "Users and Privileges". Click this.
-
Here, we need to set up a database user according to the configuration of the program. Click "Add Account". Give it the login name "ghoul", and the password "ghoul_user!61". Select the "Administrative Roles" tab, and click the "DBA" checkmark, which will select everything. Select the "Schema Privileges" tab, and click the "Select "ALL"" button to give this user all privileges. Finalize this by clicking the "Apply" button.
-
With the user created, we now need to create the database itself. In the workbench, the words "Schema" and "Database" are used interchangeably, so press the button in the topbar represented by a cylinder to add the schemas that we need.
-
All you need to enter in the Schema Editor is the schema name. Give it the name "ghoul_development" and press the small "Apply" button to the bottom right. Repeat this process to create another schema called "ghoul_test". We will use that later when testing is implemented.
-
This is all we need to do to set the database up - Sequelize will take care of creating tables. Navigate to the GhoulAlert directory in the command line/terminal and run the application, and it should successfully connect to and shape the database based on the existing models.
-
Now that the database is set up, let's test the program MVC flow. As of now, we have a view (index.pug) that has a section that iterates on each user that exists, as sent to the view by the route, which in turn attains that data from Sequelize reading the user.js model. We can use this view to make sure each step of that process works.
-
Open the MySQL Workbench window again. We need to make a quick modification for the manual insertions we will make to work. On the left panel, open the Schemas tab. Drop down the "ghoul_development" schema, and "Tables". Hover over "Users", and click the wrench icon. Click on the row for "createdAt", and in the "Default" field, type "Now()". Do the same for the "updatedAt" row, then press the "Apply" button at the bottom right and apply these changes.
-
In the middle section, there should be a tab starting with the word "Query". Select this tab and paste the following code (making sure it's the only text present):
INSERT INTO ghoul_development.Users(username, password)
VALUES ("Manmoth", "bright_light");
Press the lightning bolt in the bar above the code to run this query.
- Run the GhoulAlert application. Once it's active, navigate to localhost:3000. Under Users, Manmoth's name should be listed.
Catching up to this point is vital to contributing to the project. Complete these instructions and you will be ready when it's time to delegate coding work.