Skip to content

Commit 548b1ab

Browse files
vogloblinskyvogloblinsky
committed
feat(app): initial commit with standalone architecture
0 parents  commit 548b1ab

File tree

81 files changed

+15205
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+15205
-0
lines changed

‎.editorconfig

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Editor configuration, see https://editorconfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
indent_style = space
7+
indent_size = 4
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.ts]
12+
quote_type = single
13+
14+
[*.md]
15+
max_line_length = off
16+
trim_trailing_whitespace = false

‎.github/workflows/main.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: CI
4+
5+
# Controls when the action will run. Triggers the workflow on push or pull request
6+
# events but only for the master branch
7+
on:
8+
push:
9+
branches: [main]
10+
pull_request:
11+
branches: [main]
12+
13+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
14+
jobs:
15+
# This workflow contains a single job called "build"
16+
build:
17+
# The type of runner that the job will run on
18+
runs-on: ubuntu-latest
19+
20+
# Steps represent a sequence of tasks that will be executed as part of the job
21+
steps:
22+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
23+
- uses: actions/checkout@v2
24+
25+
- name: Cache node modules
26+
uses: actions/cache@v1
27+
with:
28+
path: node_modules
29+
key: ${{ runner.OS }}-build-${{ hashFiles('**/package-lock.json') }}
30+
restore-keys: |
31+
${{ runner.OS }}-build-${{ env.cache-name }}-
32+
${{ runner.OS }}-build-
33+
${{ runner.OS }}-
34+
35+
- name: Install Dependencies
36+
run: npm ci
37+
- name: Build doc
38+
run: npm run doc
39+
- name: Archive www Artifact
40+
uses: actions/upload-artifact@master
41+
with:
42+
name: documentation
43+
path: documentation
44+
deploy:
45+
name: Deploy 🚀
46+
needs: [build]
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Checkout Repo
50+
uses: actions/checkout@master
51+
- name: Download Artifact
52+
uses: actions/download-artifact@master
53+
with:
54+
name: documentation
55+
path: documentation
56+
- name: Deploy to github pages
57+
uses: JamesIves/[email protected]
58+
with:
59+
GITHUB_TOKEN: ${{ secrets.COMPODOC_GITHUB_PAGES_TOKEN }}
60+
BRANCH: gh-pages # The branch the action should deploy to.
61+
FOLDER: documentation # The folder the action should deploy.
62+
CLEAN: true # Automatically remove deleted files from the deploy branch

‎.gitignore

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# See http://help.github.com/ignore-files/ for more about ignoring files.
2+
3+
# Compiled output
4+
/dist
5+
/tmp
6+
/out-tsc
7+
/bazel-out
8+
9+
# Node
10+
/node_modules
11+
npm-debug.log
12+
yarn-error.log
13+
14+
# IDEs and editors
15+
.idea/
16+
.project
17+
.classpath
18+
.c9/
19+
*.launch
20+
.settings/
21+
*.sublime-workspace
22+
23+
# Visual Studio Code
24+
.vscode/*
25+
!.vscode/settings.json
26+
!.vscode/tasks.json
27+
!.vscode/launch.json
28+
!.vscode/extensions.json
29+
.history/*
30+
31+
# Miscellaneous
32+
/.angular/cache
33+
.sass-cache/
34+
/connect.lock
35+
/coverage
36+
/libpeerconnection.log
37+
testem.log
38+
/typings
39+
40+
# System files
41+
.DS_Store
42+
Thumbs.db
43+
44+
documentation

‎README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Compodoc Demo TodoMVC Angular
2+
3+
This project was generated with [angular-cli](https://github.com/angular/angular-cli).
4+
5+
It is a demo project for demonstrating Compodoc features :
6+
7+
- architecture
8+
- components documentation
9+
- embedding images
10+
- documentating methods and properties of components, classes, interfaces, etc...
11+
12+
## Development server
13+
14+
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
15+
16+
## Code scaffolding
17+
18+
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive/pipe/service/class/module`.
19+
20+
## Build
21+
22+
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
23+
24+
## Further help
25+
26+
To get more help on the `angular-cli` use `ng --help` or go check out the [Angular-CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
27+
28+
## Compodoc supports syntax highlighting
29+
30+
```javascript
31+
function hello() {
32+
console.log("hello world !");
33+
}
34+
```
35+
36+
## Screenshots of the application - (for assets embedding demo)
37+
38+
| Home page | About page |
39+
| ------------------------------------- | -------------------------------------- |
40+
| ![Screenshot-1](screenshots/home.png) | ![Screenshot-2](screenshots/about.png) |

‎angular.json

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
{
2+
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
3+
"version": 1,
4+
"newProjectRoot": "projects",
5+
"projects": {
6+
"compodoc-demo-todomvc-angular-standalone": {
7+
"projectType": "application",
8+
"schematics": {
9+
"@schematics/angular:class": {
10+
"skipTests": true
11+
},
12+
"@schematics/angular:component": {
13+
"skipTests": true
14+
},
15+
"@schematics/angular:directive": {
16+
"skipTests": true
17+
},
18+
"@schematics/angular:guard": {
19+
"skipTests": true
20+
},
21+
"@schematics/angular:interceptor": {
22+
"skipTests": true
23+
},
24+
"@schematics/angular:pipe": {
25+
"skipTests": true
26+
},
27+
"@schematics/angular:resolver": {
28+
"skipTests": true
29+
},
30+
"@schematics/angular:service": {
31+
"skipTests": true
32+
}
33+
},
34+
"root": "",
35+
"sourceRoot": "src",
36+
"prefix": "app",
37+
"architect": {
38+
"build": {
39+
"builder": "@angular-devkit/build-angular:application",
40+
"options": {
41+
"outputPath": "dist/compodoc-demo-todomvc-angular-standalone",
42+
"index": "src/index.html",
43+
"browser": "src/main.ts",
44+
"polyfills": ["zone.js"],
45+
"tsConfig": "tsconfig.app.json",
46+
"assets": ["src/favicon.ico", "src/assets"],
47+
"styles": [
48+
"src/styles.css",
49+
"node_modules/todomvc-common/base.css",
50+
"node_modules/todomvc-app-css/index.css"
51+
],
52+
"scripts": []
53+
},
54+
"configurations": {
55+
"production": {
56+
"budgets": [
57+
{
58+
"type": "initial",
59+
"maximumWarning": "500kb",
60+
"maximumError": "1mb"
61+
},
62+
{
63+
"type": "anyComponentStyle",
64+
"maximumWarning": "2kb",
65+
"maximumError": "4kb"
66+
}
67+
],
68+
"outputHashing": "all"
69+
},
70+
"development": {
71+
"optimization": false,
72+
"extractLicenses": false,
73+
"sourceMap": true
74+
}
75+
},
76+
"defaultConfiguration": "production"
77+
},
78+
"serve": {
79+
"builder": "@angular-devkit/build-angular:dev-server",
80+
"configurations": {
81+
"production": {
82+
"buildTarget": "compodoc-demo-todomvc-angular-standalone:build:production"
83+
},
84+
"development": {
85+
"buildTarget": "compodoc-demo-todomvc-angular-standalone:build:development"
86+
}
87+
},
88+
"defaultConfiguration": "development"
89+
}
90+
}
91+
}
92+
}
93+
}

0 commit comments

Comments
 (0)