Skip to content

Commit 4e4497f

Browse files
Awk34gitbook-bot
Awk34
authored and
gitbook-bot
committed
GitBook: [master] 15 pages and 8 assets modified
1 parent 6343f34 commit 4e4497f

23 files changed

+968
-0
lines changed

‎.gitbook/assets/image (1).png

170 KB
Loading

‎.gitbook/assets/image (2).png

78.6 KB
Loading

‎.gitbook/assets/image (3).png

170 KB
Loading

‎.gitbook/assets/image (4).png

120 KB
Loading

‎.gitbook/assets/image (5).png

29.3 KB
Loading

‎.gitbook/assets/image (6).png

31.1 KB
Loading

‎.gitbook/assets/image (7).png

19.6 KB
Loading

‎.gitbook/assets/image.png

148 KB
Loading

‎README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# The Angular Full-Stack Generator
2+
3+
![](.gitbook/assets/image%20%287%29.png)
4+
5+
### Install & run the generator.
6+
7+
Install Yeoman, generator-angular-fullstack, & the Gulp CLI
8+
9+
```bash
10+
$ npm install --global yo generator-angular-fullstack gulp-cli
11+
```
12+
13+
Make a new folder for your project, scope into it, and run the generator.
14+
15+
```bash
16+
$ mkdir example && cd $_
17+
$ yo angular-fullstack
18+
...
19+
```
20+
21+
Answer the generator's questions to scaffold an app tailored to your preferences.
22+
23+
### Get up and running
24+
25+
Start the development server
26+
27+
```bash
28+
$ npm run start:server
29+
```
30+
31+
```bash
32+
$ npm run start:client
33+
```
34+
35+
The client CLI will show you where to access your running server in a browser
36+
37+
![](.gitbook/assets/image.png)
38+

‎SUMMARY.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Table of contents
2+
3+
* [The Angular Full-Stack Generator](README.md)
4+
5+
## Getting Started
6+
7+
* [Pre-Requisites](getting-started/pre-requisites.md)
8+
* [Installation](getting-started/installation.md)
9+
* [Running](getting-started/running.md)
10+
* [Project Overview](getting-started/project-overview.md)
11+
12+
## Developing
13+
14+
* [Overview](developing/overview.md)
15+
* [Adding a Route](developing/adding-a-route.md)
16+
17+
## Deployment
18+
19+
* [Manual Deployment](deployment/manual-deployment.md)
20+
* [Google Cloud Deployment](deployment/untitled-1.md)
21+
* [index](deployment/untitled.md)
22+
23+
## Generators
24+
25+
* [App](generators/app.md)
26+
* [Endpoint](generators/endpoint.md)
27+
28+
## Contributing
29+
30+
* [Releasing a New Version](contributing/releasing-a-new-version.md)
31+
* [Commit Style](contributing/untitled-1.md)
32+

‎contributing/releasing-a-new-version.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Releasing a New Version
2+
3+
## Contributing
4+
5+
## Releasing a new version
6+
7+
* Bump `package.json` version
8+
* \[
9+
* `grunt conventionalChangelog`
10+
* `cd angular-fullstack-deps`
11+
* `git checkout master`
12+
* `git pull`
13+
* `cd ..`
14+
* `gulp updateFixtures:deps`
15+
* `cd angular-fullstack-deps`
16+
* `git add .`
17+
* `git commit -m $VERSION`
18+
* `git push`
19+
* `# npm publish`
20+
21+
\]
22+
* `git add ./{CHANGELOG.md,angular-fullstack-deps,package.json}`
23+
* `git commit -m $VERSION`
24+
* `git push`
25+
* `# npm publish`
26+

‎contributing/untitled-1.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Commit Style
2+
3+
## Commit Message Format
4+
5+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
6+
7+
```text
8+
<type>(<scope>): <subject>
9+
<BLANK LINE>
10+
<body>
11+
<BLANK LINE>
12+
<footer>
13+
```
14+
15+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on github as well as in various git tools.
16+
17+
## Type
18+
19+
Must be one of the following:
20+
21+
* **feat**: A new feature
22+
* **fix**: A bug fix
23+
* **docs**: Documentation only changes
24+
* **style**: Changes that do not affect the meaning of the code \(white-space, formatting, missing
25+
26+
semi-colons, etc\)
27+
28+
* **refactor**: A code change that neither fixes a bug or adds a feature
29+
* **test**: Adding missing tests
30+
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
31+
32+
generation
33+
34+
## Scope
35+
36+
The scope could be anything specifying place of the commit change. For example `app`, `gen`, `docs`, `gen:view`, `gen:route`, `gen:service`, etc...
37+
38+
## Subject
39+
40+
The subject contains succinct description of the change:
41+
42+
* use the imperative, present tense: "change" not "changed" nor "changes"
43+
* don't capitalize first letter
44+
* no dot \(.\) at the end
45+
46+
## Body
47+
48+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes" The body should include the motivation for the change and contrast this with previous behavior.
49+
50+
## Footer
51+
52+
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
53+
54+
A detailed explanation can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y).
55+

‎deployment/manual-deployment.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Deployment
3+
sort: 0
4+
---
5+
6+
# Manual Deployment
7+
8+
{% hint style="warning" %}
9+
## \[STUB\]
10+
{% endhint %}
11+
12+
## Deployment
13+
14+
### Manual \(Linux server\)
15+
16+
1. Run `gulp build`. This will build your project into the `dist` folder by default.
17+
2. Zip up the contents of your `dist` folder and send it off to your server.
18+
3. On your server, unzip your built files somewhere on the disk. Ex: in a `myproj` folder.
19+
4. ```bash
20+
$ cd myproj
21+
```
22+
5. ```text
23+
$ NODE_ENV=production node ./server
24+
```
25+
26+
### [Gcloud App Engine \(Standard Environment\)](gcloud-deployment.md)
27+

‎deployment/untitled-1.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Google Cloud Deployment
2+
3+
The following are the instructions to deploy the angular-fullstack app to Google Cloud App Engine Standard Environment
4+
5+
## Prequsites
6+
7+
### 1. Google Cloud SDK
8+
9+
Download and install [Google Cloud SDK](https://cloud.google.com/sdk/)
10+
11+
### 2. Create GCP Project
12+
13+
```bash
14+
gcloud projects create [PROJECT_ID]
15+
```
16+
17+
`[PROJECT_ID]` ID for the project you want to create.
18+
19+
### 3. Enable Billing
20+
21+
You need to enable billing for your project before you begin using App Engine
22+
23+
```bash
24+
gcloud alpha billing projects link my-project \
25+
--billing-account 0X0X0X-0X0X0X-0X0X0X
26+
```
27+
28+
[gcloud alpha billing projects link](https://cloud.google.com/sdk/gcloud/reference/alpha/billing/projects/link)
29+
30+
### 4. Create a MongoDB database
31+
32+
Create a MongoDB instance and obtain the uri and credentials. There are multiple options for creating a new MongoDB database.
33+
34+
* Create a Google Compute Engine virtual machine with [MongoDB pre-installed](https://cloud.google.com/launcher/?q=mongodb).
35+
* Create a MongoDB instance with [MongoDB Atlas on GCP](https://www.mongodb.com/cloud/atlas/mongodb-google-cloud).
36+
* Use [mLab](https://mlab.com/google) to create a free MongoDB deployment on Google Cloud Platform.
37+
38+
## Deployment Setup
39+
40+
### 1. Set Node / NPM versions
41+
42+
```text
43+
GCloud App Engine supports only the newest version of Node.js 8
44+
```
45+
46+
```javascript
47+
"engines": {
48+
"node": ">=8.0",
49+
"npm": "^5.1.1"
50+
},
51+
```
52+
53+
### 2. Create Application configuration file \(app.yaml\)
54+
55+
```text
56+
A Node.js app in App Engine is configured through a file named app.yaml, that contains runtime, handlers,
57+
scaling, and other general settings including environment variables.
58+
59+
2.1 create a 'app.yaml' file with the following contents
60+
```
61+
62+
```yaml
63+
env: standard
64+
65+
runtime: nodejs8
66+
67+
env_variables:
68+
MONGODB_URI: "mongodb://<dbuser :<dbpassword @<environment_URI/deployment_name"
69+
```
70+
71+
```text
72+
2.2 Add app.yaml to .gitignore
73+
```
74+
75+
## Deployment Steps
76+
77+
### 1. Build the app
78+
79+
```bash
80+
gulp build
81+
```
82+
83+
### 2. Copy app.yaml to dist
84+
85+
```bash
86+
cp app.yaml dist
87+
```
88+
89+
### 3. Change to build directory
90+
91+
```bash
92+
cd dist
93+
```
94+
95+
### 4. Deploy
96+
97+
```bash
98+
gcloud app deploy
99+
```
100+

0 commit comments

Comments
 (0)