aplorenzen / ngx-neo-website

My personal website, based on the creative bootstrap theme - neoprime.it

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ngx-neo-website

This project is my personal "resume style" website. I host it on these locations: neoprime.it, neoprime.dk and neoprime.org.

If you are interested in making something similar, feel free to use this project as a template, or to get inspired.

The project was generated with ngX-Rocket version 4.0.0.

Features

  • Onepage personal resume site
  • Docker containerization in httpd
  • Pre-rendering (for SEO)
  • SEO optimizations
  • Automated delivery with Jenkins pipeline
  • Translations (from ngX-Rocket)
  • API lookup (from ngX-Rocket)

Getting started

If you want to run and develop a local version, here's what you got to do after cloning the project from here.

  1. Go to project folder and install dependencies:
npm install
  1. Launch development server, and open localhost:4200 in your browser:
npm start

Start hacking!

Project structure

dist-prerender/              prerendered javascript bundle build 
dist/                        web app production build
docs/                        project docs and coding guides
e2e/                         end-to-end tests
src/                         project source code
|- app/                      app components
|  |- core/                  core module (singleton services and single-use components)
|  |- shared/                shared module  (common components, directives and pipes)
|  |- app.component.*        app root component (shell)
|  |- app.module.ts          app root module definition
|  |- app-routing.module.ts  app routes
|  +- ...                    additional modules and components
|- assets/                   app assets (images, fonts, sounds...)
|- docker/                   docker container definitions
|- environments/             values for various build environments
|- theme/                    app global scss variables and theme
|- translations/             translations files
|- index.html                html entry point
|- main.scss                 global style entry point
|- main.ts                   app entry point
|- main-prerender.ts         prerendered app entry point
|- polyfills.ts              polyfills needed by Angular
|- robots.txt                robots.txt, pointing to sitemap.xml
|- sitemap.xml               sitemap deployed to the application image
+- test.ts                   unit tests entry point
reports/                     test and coverage reports
proxy.conf.js                backend proxy configuration

Main tasks

Task automation is based on NPM scripts.

Task Description
npm start Run development server on http://localhost:4200/
npm run build [-- --env=prod] Lint code and build web app for production (with AOT) in dist/ folder
npm test Run unit tests via Karma in watch mode
npm run test:ci Lint code and run unit tests once for continuous integration
npm run e2e Run e2e tests using Protractor
npm run lint Lint code
npm run translations:extract Extract strings from code and templates to src/app/translations/template.json
npm run docs Display project documentation

When building the application, you can specify the target environment using the additional flag --env <name> (do not forget to prepend -- to pass arguments to npm scripts).

The default build environment is prod.

Development server

Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. You should not use ng serve directly, as it does not use the backend proxy configuration by default.

Code scaffolding

Run npm run generate -- component <name> to generate a new component. You can also use npm run generate -- directive|pipe|service|class|module.

If you have installed angular-cli globally with npm install -g @angular/cli, you can also use the command ng generate directly.

Additional tools

Tasks are mostly based on the angular-cli tool. Use ng help to get more help or go check out the Angular-CLI README.

What's in the box

The app template is based on HTML5, TypeScript and Sass. The translation files use the common JSON format.

Tools

Development, build and quality processes are based on angular-cli and NPM scripts, which includes:

Libraries

Coding guides

Other documentation

Dependencies

TODO: Add all dependencies since 'ngx-rocket new'

Docker

Going to use the httpd (Apache) image to host the production application.

https://hub.docker.com/_/httpd/

About

My personal website, based on the creative bootstrap theme - neoprime.it


Languages

Language:TypeScript 69.9%Language:HTML 13.0%Language:CSS 6.6%Language:JavaScript 4.6%Language:Dockerfile 4.4%Language:Shell 1.4%