https://github.com/jolares/example-angular-blog-with-scully-ssg
https://github.com/jolares/example-angular-blog-with-scully-ssg
angular blog scully static-site-generator
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jolares/example-angular-blog-with-scully-ssg
- Owner: jolares
- Created: 2021-10-31T16:00:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-31T20:49:09.000Z (over 4 years ago)
- Last Synced: 2025-06-16T05:45:16.764Z (about 1 year ago)
- Topics: angular, blog, scully, static-site-generator
- Language: TypeScript
- Homepage:
- Size: 216 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Example Angular blog built with Scully SSG**
A sample blog app developed with Angular and built as a static site using
Scully SSG (static site generator). Blog posts are written in markdown files and
converted to static html by Scully's build process.
Scully is a static site generator tool for Angular to build, test and deploy
Jamstack apps.
Instructions for developing and scaffolding, building, and testing this project
are found below.
### **Screenshots**
Figure 1
Home page. The angular application is built using the angular-cli and then post-processed to a static site using Scully.
Figure 2
Blog post page. The blog post content is written in markdown files and compiled to static html using Scully.
## **Development server**
## **Run Angular Static Site App with Blog Posts**
Run `npm run start` for a dev server. Navigate to `http://localhost:1668/`. The app will automatically reload if you change any of the source files.
## **Run Angular App Only (without SSG, blog posts)**
Run `npm run _start:ng` for an angular dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## **Code scaffolding**
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
## **Build**
### **Build App as Static Site** (Using Angular CLI + Scully)
Run `ng build` to build the project as static-site, generated by first building
the app using the angular-cli and then building the static site using Scully
SSG (static site generator). The build artifacts will be stored in the `dist/` directory.
Run `ng build:ssg` to build the project as static-site only using scully. Note
that the scully build depends on the angular build to have been run first,
(either by running `npm run build:ng` or `npm run build`) using the
angular-cli before. The build artifacts will be stored in the `dist/` directory.
### **Build App as Angular project** (Using Angular CLI Only)
Run `ng build:ng` to build the project using the angular-cli only.
The build artifacts will be stored in the `dist/` directory.
## **Running Tests**
### **Unit tests**
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
### **End-to-end tests**
Run `npm run test:e2e` to execute the end-to-end tests via a platform of your choice.
To use this command, you need to first add a package that implements end-to-end testing capabilities.
-----
## **References**
- [Angular](https://angular.io/) and [Angular CLI](https://github.com/angular/angular-cli)
- [Scully](https://scully.io/)
- [Jamstack](https://jamstack.org/)
## TODOs
- integrate CDN and Google Analytics
- ensure perfect accessibility score
- Add Responsive
- Add Mobile Site
- Add tests
- Add Link to Blog post