Methods
checkCopyType(options, type)
Checks what folder to copy
| Name | Type | Description |
|---|---|---|
options |
Object | |
type |
String | Name of the folder |
- Source:
cli(args)
Starting the main program
| Name | Type | Description |
|---|---|---|
args |
Array.<String> |
copyFiles({Object))
Copies the setup folder per project.
| Name | Type | Description |
|---|---|---|
{Object) |
options |
- Source:
createENVPy(options)
Generates env.py used for python projects
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
createGitIgnore(options)
Generates a custom .gitignore file depending on project
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
createHTML(options)
Generates HTML for projects
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
createMarkdown(options)
Generates README and Markdown files
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
createProcfile(options)
Generates a custom Procfile depending on project
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
createProject(options)
Main function to create a project
| Name | Type | Description |
|---|---|---|
options |
Object |
createProjectDir(options) → {Promise}
Creates the main Project directory.
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
Target Directory if created
- Type
- Promise
createVSCodeSettings(options)
Generates vscode settings per project.
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
djangoApp()
Installs Django into the virtual environment
- Source:
djangoOnly() → {String}
Generate variables only used by Django
- Source:
Stripe & AWS information
- Type
- String
(async) djangoSettings() → {Pormise.<String>}
Django specific settings
- Source:
Stripe & AWS Settings
- Type
- Pormise.<String>
(async) doesEnvExistForProject(options)
Checking if the user has created a virtual enviroment before
| Name | Type | Description |
|---|---|---|
options |
Object |
(async) envQuestions(options)
Questions if the user wants us to create a virtual enviroment or if the user has one already what is the name of the folder.
| Name | Type | Description |
|---|---|---|
options |
Object |
flaskApp()
Install Flask into the virtual environment
- Source:
flaskOnly() → {String}
Generate variables only used by flask
- Source:
MongoDB information and Port
- Type
- String
(async) flaskSettings() → {Promise.<String>}
Flask specific settings
- Source:
Mongo URI Settings
- Type
- Promise.<String>
generateENVFile(options) → {Promise.<String>}
Generate environmental variables for env.py
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
Hostname and random generated string
- Type
- Promise.<String>
generateHTML(config) → {Promise.<String>}
This will generate the html for Milestone 1 and Milestone 2
| Name | Type | Description |
|---|---|---|
config |
Object | Configuration options |
- Source:
Customized HTML 5 Boiler template
- Type
- Promise.<String>
(async) generatePath(config, os) → {Promise.<String>}
Generates correct path for virtual enviroment
| Name | Type | Description |
|---|---|---|
config |
Object | |
os |
String |
- Source:
Customized OS path for virutal enviroment
- Type
- Promise.<String>
generatePythonSettings(config)
Generates python specific vscode settings. This includes a secret key and linting
| Name | Type | Description |
|---|---|---|
config |
Object |
- Source:
Customized vscode settings per OS.
generateREADME(config) → {Promise.<String>}
Generates the Boilerplate for the Readme file
| Name | Type | Description |
|---|---|---|
config |
Object |
- Source:
Custom boilerplate for README.md
- Type
- Promise.<String>
generateRequirements(options)
Generates the requirements.txt for Milestone 3 or Milestone 4
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
generateTESTING() → {String}
Generates the Testing.md for the project with boilerplate
- Source:
Full boilerplate for Testing.md
- Type
- String
(async) getDevNul() → {Promise.<String>}
Checks if we want to use dev/null or Nul
- Source:
Nul or dev/null
- Type
- Promise.<String>
getOS() → {Promise.<String>}
This will return the name of the platform
- Source:
- Name of platform
- Type
- Promise.<String>
gitTasks(options)
Will execute git init and git add with a commit
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
installVirtualEnv(options)
Installing and using virtualenv
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
(async) parseArgumentsIntoOptions(rawArgs)
Input taken directly from the user
| Name | Type | Description |
|---|---|---|
rawArgs |
Array.<String> |
(async) pipInstallAndFreeze(options)
Using virtualenv to freeze and install correct pip packages
| Name | Type | Description |
|---|---|---|
options |
Object |
- Source:
(async) promptForMissingOptions(options)
| Name | Type | Description |
|---|---|---|
options |
Object |
(async) targetOS(options, platform)
Sets up the correct targets for use depending on OS
| Name | Type | Description |
|---|---|---|
options |
Object | |
platform |
String |
- Source:
title(text, font)
Creating custom title
| Name | Type | Description |
|---|---|---|
text |
String | The text to display |
font |
* | The Font used |
- Source: