Github Pages Demo

Frameworks and Languages

Demo

Description

This repository is a dummy and demo application built with Angular 19, showcasing the integration with GitHub's API. It displays user information, repositorie, and other relevant data using Angular components and services. The application is styled using SASS and leverages TailwindCSS for utility-first styling.

All my GithubPages will use this dummy application as a template for future projects.

Installation

npm i @christophhu/ngx-github-pages-demo

Use

Add your own component to the overview component

In the app.component.html file, you can use the component like this:

<ngx-github-pages-demo></ngx-github-pages-demo>

In the app.component.ts you can import the component like this:

import { NgxGithubPagesDemoComponent } from '@christophhu/ngx-github-pages-demo';
...

@Component({
  selector: 'app-root',
  imports: [
    NgxGithubPagesDemoComponent,
  ],
  templateUrl: './app.component.html',
  styleUrl: './app.component.sass'
})
export class AppComponent {}

Configure the Github-Page in the app.config.ts file:

export const appConfig: ApplicationConfig = {
  providers: [
    provideHttpClient(),
    provideGithubPagesDemo({ username: 'christophhu', repository: 'ngx-github-pages-demo', version: '0.0.3', template: TemplateComponent }),
    provideZoneChangeDetection({ eventCoalescing: true }), 
    provideRouter(routes)
  ]
}

The Username ist the name of the user or organization, the repository is the name of the repository and the version is the version you will name it. The template is the component that will be used to display the data. It will be shown in the overview component.

At last there must be a route to the overview and readme component in the app.routes.ts file:

export const routes: Routes = [...pageRoutes]

You cann add the routes kile this or add them to your own routes.

Styling

You have to add your own style, use the default or add default.css. You can use the default style by adding the default.css file in node_modules/@christophhu/ngx-github-pages-demo/lib/. You have to import it to your angular.json file:

"styles": [
  "src/styles.css",
  "node_modules/@christophhu/ngx-github-pages-demo/lib/default.css"
],

License

This project is licensed under the MIT License.

The MIT License (MIT) Copyright © 2024

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.