-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
35 changed files
with
14,558 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "installation": { | ||
| "title": "Installation" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| ## Contents | ||
|
|
||
| > 1. [Prequisites](#prequisites) | ||
| > 1. [Structure](#structure) | ||
| > 1. [Setup](#setup) | ||
| > 1. [Pre-Configuration](#pre-configuration) | ||
| > 1. [Installing](#installing) | ||
| > 1. [Post-Configuration](#post-configuration) | ||
| > 1. [Launching](#launching) | ||
| > 1. [Modules](#modules) | ||
| > 1. [dffrnt.utils](#dffrntutils) | ||
| > 1. [dffrnt.model](#dffrntmodel) | ||
| > 1. [dffrnt.route](#dffrntroute) | ||
| > 1. [License](#license) | ||
| --- | ||
| ## Prequisites | ||
| > * [NodeJS](https://nodejs.org/en/) (_Latest_) | ||
| > * [NPM](https://nodejs.org/en/) (_Installed with `NodeJS`_) | ||
| > * [REDIS](https://redis.io/download) (_See **[Structure](#structure)** below_) | ||
| > * _Install this in the same **parent folder** as **this project** under `REDIS/`_ | ||
| > * [MySQL](https://dev.mysql.com/downloads/mysql/) (_v5.6+_) | ||
| > * _A `user@%` account is **required** for later configuration_ | ||
| ### Structure | ||
|
|
||
| ``` | ||
| Parent_Folder/ (Name NOT important) | ||
| ├── dffrnt.api/ (Project-Root; any no-spaced Name will do) | ||
| │ ├── config/ (Reference only; no need to create these!) | ||
| │ └── ... | ||
| └── REDIS/ (Name important! Don't change this name!!) | ||
| ``` | ||
|
|
||
| > In this document, **`./`**, refers to the **project root**; while, **`../`**, refers to the **parent folder** | ||
| --- | ||
| ## Setup | ||
|
|
||
| ### Pre-Configuration | ||
| 1. Ensure the **[folder structure](#structure)** is setup. | ||
| 1. Ensure the **[prequisites](#prequisites)** are installed. | ||
| * If the `install method` you chose for `REDIS` installs the files in a default location, be sure to `symlink` that location to the `../REDIS/` directory. | ||
| 1. In the `MySQL` database, create a `user@%` for yourself. | ||
| * Be sure to give yourself appropriate permissions. | ||
| 1. Configure the `redis.conf` file in the `../REDIS/` folder: | ||
|
|
||
| ```apacheconf | ||
| # ../REDIS/redis.conf | ||
| ################################## SECURITY ################################### | ||
| # Require clients to issue AUTH <PASSWORD> before processing any other | ||
| # ... | ||
| # use a very strong password otherwise it will be very easy to break. | ||
| # | ||
| requirepass p@ssw0rd_h3r3! | ||
| ``` | ||
|
|
||
| ### Installing | ||
| 1. [Download](https://github.com/DFFR-NT/dffrnt.api/archive/master.zip) or [`git`](https://github.com/DFFR-NT/dffrnt.api.git) this project into the **parent folder**. | ||
| 1. In your **command line**, `cd` into the **project root** location. | ||
| 1. Install some packages at the `global` level: | ||
| 1. Run `chmod +x ./.docs/npm_global.sh` to make it **excutable**. | ||
| 1. Run `sudo ./.docs/npm_global.sh` to install some important, **global* packages. | ||
| > These can be utilized across ANY or your projects: | ||
| | Package | Description | | ||
| | --- | --- | | ||
| | [babel-cli](https://www.npmjs.com/package/babel-cli) | A next-gen (`ES6`) JavaScript compiler. | | ||
| | [bower](https://www.npmjs.com/package/bower) | A package-manager for Browser `plugins`. | | ||
| | [cors](https://www.npmjs.com/package/cors) | A `middleware` for `Cross-Origin Resource Sharing`. | | ||
| | [depcheck](https://www.npmjs.com/package/depcheck) | A tool for analyzing the `dependencies` in a project | | ||
| | [express](https://www.npmjs.com/package/express) | A fast, unopinionated, minimalist web framework for `NodeJS`. | | ||
| | [gulp](https://www.npmjs.com/package/gulp) | A toolkit that helps automate development workflow `tasks`. | | ||
| | [less](https://www.npmjs.com/package/less) | The dynamic `stylesheet` language. | | ||
| | [less-plugin-clean-css](https://www.npmjs.com/package/less-plugin-clean-css) | A `gulp` plugin for `LESS -> CSS` using `clean-css`. | | ||
| | [nodemon](https://www.npmjs.com/package/nodemon) | Will watch for files changes and `restart` your application. | | ||
|
|
||
| 1. Run `npm link gulp && gulp setup` to: | ||
| * Install the `npm packages`. | ||
| * Install the `bower components`. | ||
| * Initialize the `config files`. | ||
| * Link the `framework modules`. | ||
|
|
||
| ### Post-Configuration | ||
| 1. In the `./config/` folder, configure the `settings.js` file: | ||
|
|
||
| ```javascript | ||
| // ./config/settings.js | ||
| export default { | ||
| Debug: true, // Debug‑Mode will display verbose Logs | ||
| Port: 3001, // This is the Server's listening Port | ||
| Public: { | ||
| // Cache‑Age for Browser files | ||
| Age: 365*86400, | ||
| // ... | ||
| }, | ||
| Session: { | ||
| // This should be something hard to guess, like a phrase | ||
| Secret: '¿mYd0GiS!nmYeyE&shEs4yS@uE?', | ||
| Age: (((3600*1000)*4)*1), // TTL for User Sessions | ||
| REDIS: { | ||
| Host: 'localhost', // Or whereever you keep it | ||
| Port: 6379, // Listening Port | ||
| // The password you configured earlier | ||
| Password: 'p@ssw0rd!', | ||
| }, | ||
| Auth: { /* ... */ } | ||
| } | ||
| }; | ||
| ``` | ||
| 1. Still in the `./config/` folder, configure the `database.js` file: | ||
|
|
||
| ```javascript | ||
| // ./config/database.js | ||
| export default { | ||
| Config: { | ||
| user: 'user', // The one you created in MySQL | ||
| database: 'mydatabase', // The DB | ||
| // ... | ||
| }, | ||
| Pool: { | ||
| HeadEx1: { | ||
| host: 'XXX.XXX.XXX.XXX', // The eVectr IP | ||
| // The one you created in MySQL | ||
| password: 'p@ssw0rd_h3r3!' | ||
| }, | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| ### Launching | ||
| 1. Lastly, still in the **project root**, type `gulp` and hit <kbd>ENTER</kbd> to run, and watch the `logs` as the `server` starts up: | ||
|
|
||
| >  | ||
| > _Initial `gulp` tasks being completed._ | ||
| >  | ||
| > _File monitoring, courtesy of `nodemon`._ | ||
| >  | ||
| > _The `node` server starting up._ | ||
| * If there are no _glaring_ `errors`, you're done! | ||
| * Otherwise... Sh!t..? ¯\\_(ツ)\_/¯ | ||
| 1. In your `browser`, navigate to [localhost:3001/api-explorer](http://localhost:3001/api-explorer) (_or whatever `port` you chose_) and you'll see the **API Exploration UI**. Use this to test your `endpoints` and/or `signle sign-on` functionality. | ||
| 1. Hit <kbd>CTRL</kbd>+<kbd>C</kbd> to `stop` the server. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.