-
Notifications
You must be signed in to change notification settings - Fork 4
feat(docs): migrated to SSR (#DS-3683) #1121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
6f92a59
feat(docs): migrated to SSR (#DS-3683)
artembelik d53abbf
feat(docs): migrated to SSR (#DS-3683)
artembelik ba4bb4c
refactor: readme
artembelik def2dc6
refactor: firebase schema
artembelik 934df2e
refactor: env
artembelik ab4b055
refactor: firebase public
artembelik f4a808d
chore: firebase
artembelik 99a441f
chore: anchors
artembelik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -1,51 +1,41 @@ | ||
| ## [Production Build](../../.github/workflows/actions/build-docs/action.yml) | ||
| # Documentation application | ||
|
|
||
| Before building the documentation, you must first [build packages](#build-packages) and [generate sitemap](#generate-sitemapxml) | ||
| This is the [Koobiq design system](https://koobiq.io/en) website application. | ||
|
|
||
| ```bash | ||
| yarn run build:docs-examples-module && | ||
| yarn run build:docs-examples && | ||
| yarn run build:docs-content && | ||
| yarn run build:package-docs-content && | ||
| yarn run docs:build | ||
| ``` | ||
| ## Development | ||
|
|
||
| ## Generate `sitemap.xml` | ||
| Make sure you have the [correct version](.nvmrc) of Node.js installed (we recommend using [nvm](https://github.com/nvm-sh/nvm)). | ||
|
|
||
| ```bash | ||
| yarn run docs:generate-sitemap | ||
| ``` | ||
| # Setup Node.js | ||
| nvm use | ||
|
|
||
| ## Build packages | ||
| # Install dependencies | ||
| yarn install | ||
|
|
||
| ```bash | ||
| yarn run build:cdk && | ||
| yarn run build:components && | ||
| yarn run build:angular-luxon-adapter && | ||
| yarn run build:angular-moment-adapter && | ||
| # Build packages | ||
| yarn run build:cdk | ||
| yarn run build:angular-luxon-adapter | ||
| yarn run build:angular-moment-adapter | ||
| yarn run styles:build-all | ||
| ``` | ||
|
|
||
| ## Generate `docs-content` folder (dgeni) | ||
|
|
||
| ```bash | ||
| yarn run build:docs-content && yarn run build:package-docs-content | ||
| ``` | ||
| yarn run build:components | ||
| yarn run build:components-experimental | ||
|
artembelik marked this conversation as resolved.
|
||
|
|
||
| ## Generate basic module | ||
| # Generate content | ||
| yarn run build:docs-content | ||
| yarn run build:package-docs-content | ||
|
|
||
| ```bash | ||
| # Generate examples | ||
| yarn run build:docs-examples-module | ||
| ``` | ||
|
|
||
| ## Generate examples | ||
|
|
||
| ```bash | ||
| yarn run build:docs-examples | ||
| ``` | ||
|
|
||
| ## Debugging | ||
| # Generate sitemap | ||
| yarn run docs:generate-sitemap | ||
|
|
||
| ```bash | ||
| # Run application | ||
| yarn run docs:start:dev | ||
| # Then open http://localhost:4200 | ||
|
|
||
| # Build application | ||
| yarn run docs:build | ||
| ``` | ||
This file contains hidden or 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
This file contains hidden or 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,54 @@ | ||
| import { mergeApplicationConfig, Provider } from '@angular/core'; | ||
| import { provideServerRendering } from '@angular/platform-server'; | ||
| import { KBQ_WINDOW } from '@koobiq/components/core'; | ||
| import config from './config'; | ||
|
|
||
| const provideServerWindow = (): Provider => { | ||
|
artembelik marked this conversation as resolved.
|
||
| return { | ||
| provide: KBQ_WINDOW, | ||
| useFactory: () => { | ||
| return { | ||
| matchMedia: () => ({ | ||
| addEventListener: () => {}, | ||
| dispatchEvent: () => false, | ||
| removeEventListener: () => {}, | ||
| matches: false, | ||
| media: '', | ||
| onchange: null, | ||
| addListener: () => {}, | ||
| removeListener: () => {} | ||
| }), | ||
|
artembelik marked this conversation as resolved.
|
||
| localStorage: { | ||
| length: 0, | ||
| getItem: () => null, | ||
| setItem: () => {}, | ||
| removeItem: () => {}, | ||
| clear: () => {}, | ||
| key: () => null | ||
| }, | ||
| location: { | ||
| host: '', | ||
| protocol: '', | ||
| ancestorOrigins: {} as DOMStringList, | ||
| hash: '', | ||
| hostname: '', | ||
| href: '', | ||
| origin: '', | ||
| pathname: '/', | ||
| port: '', | ||
| search: '', | ||
| assign: () => {}, | ||
| reload: () => {}, | ||
| replace: () => {} | ||
| } | ||
| } satisfies Partial<Window>; | ||
| } | ||
| }; | ||
| }; | ||
|
|
||
| export default mergeApplicationConfig(config, { | ||
| providers: [ | ||
| provideServerRendering(), | ||
| provideServerWindow() | ||
| ] | ||
| }); | ||
This file contains hidden or 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,16 @@ | ||
| import { provideHttpClient, withFetch } from '@angular/common/http'; | ||
| import { ApplicationConfig } from '@angular/core'; | ||
| import { provideAnimations } from '@angular/platform-browser/animations'; | ||
| import { provideRouter } from '@angular/router'; | ||
| import { KBQ_LOCALE_SERVICE, KbqLocaleService, kbqLocaleServiceLangAttrNameProvider } from '@koobiq/components/core'; | ||
| import { DOCS_ROUTES } from './app/routes'; | ||
|
|
||
| export default { | ||
| providers: [ | ||
| { provide: KBQ_LOCALE_SERVICE, useClass: KbqLocaleService }, | ||
| kbqLocaleServiceLangAttrNameProvider('examples-lang'), | ||
| provideRouter(DOCS_ROUTES), | ||
| provideHttpClient(withFetch()), | ||
| provideAnimations() | ||
| ] | ||
| } satisfies ApplicationConfig; | ||
|
artembelik marked this conversation as resolved.
|
||
This file contains hidden or 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 @@ | ||
| import { bootstrapApplication, BootstrapContext } from '@angular/platform-browser'; | ||
|
artembelik marked this conversation as resolved.
|
||
| import { DocsAppComponent } from './app/app.component'; | ||
| import config from './config.server'; | ||
|
|
||
| export default (context: BootstrapContext) => bootstrapApplication(DocsAppComponent, config, context); | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,22 +1,5 @@ | ||
| import { provideHttpClient } from '@angular/common/http'; | ||
| import { enableProdMode } from '@angular/core'; | ||
| import { bootstrapApplication } from '@angular/platform-browser'; | ||
| import { provideAnimations } from '@angular/platform-browser/animations'; | ||
| import { provideRouter } from '@angular/router'; | ||
| import { KBQ_LOCALE_SERVICE, KbqLocaleService, kbqLocaleServiceLangAttrNameProvider } from '@koobiq/components/core'; | ||
| import { DocsAppComponent } from './app/app.component'; | ||
| import { DOCS_ROUTES } from './app/routes'; | ||
| import { environment } from './environments/environment'; | ||
| import config from './config'; | ||
|
|
||
| if (environment.production) { | ||
| enableProdMode(); | ||
| } | ||
|
|
||
| bootstrapApplication(DocsAppComponent, { | ||
| providers: [ | ||
| provideAnimations(), | ||
| provideHttpClient(), | ||
| provideRouter(DOCS_ROUTES), | ||
| kbqLocaleServiceLangAttrNameProvider('examples-lang'), | ||
| { provide: KBQ_LOCALE_SERVICE, useClass: KbqLocaleService }] | ||
| }).catch((error) => console.error(error)); | ||
| bootstrapApplication(DocsAppComponent, config).catch((err) => console.error(err)); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.