Skip to content

zoechbauer/ng-courses

Repository files navigation

NgCourses

This project was generated with Angular CLI version 9.1.4.

Content

With this app you can manage attended courses.

IMPORTANT Note to Missing Environments Folder

The environment.ts contains secret access data to my firebase account and therefore I stopped tracing this folder.

Please install this folder from another Angular project and change the settings according to your firebase account.

Used structure of environment.ts

export const environment = {
  production: false,
  firebase: {
    apiKey: 'your values',
    authDomain: 'your values',
    databaseURL: 'your values',
    projectId: 'your values',
    storageBucket: 'your values',
    messagingSenderId: 'your values',
    appId: 'your values',
    measurementId: 'your values',
  },
  firebaseDb: {
    collectionCourses: 'collection name for courses',
  },
  firebaseStorage: {
    pathCourseConfirmation: 'image path for course confirmation',
  },
  logo: {
    text: "Hans Zöchbauer's Kurse",
    // angular-material-icon
    maticon: 'supervisor_account',
  },
  snackbar: {
    // displayed in milliseconds
    duration: 3000,
  },
  admin: {
    // only admin is allowed to manage courses
    login: 'admin email',
    // for automatic login in development phase
    // set password to '' in production mode
    password: 'admin password',
  },
  // for starting the referenced apps on hosting server
  course_apps: {
    login: 'credentials for starting the apps',
    password: 'credentials for starting the apps',
  },
};

If you copy this code segment into your environment.ts file you can compile and run the app, but you can only test the Todo-List because this feature does not need authentication.

To test all features change the firebase credentials and other data of this code segment.

Compodoc Source Documentation

You can create a very good documentation of this project by calling npm run compodoc . Compodoc creates the documents in the folder documentation. At the moment (June, 2020) there are still some problems generating documentation with Angular 9. Components are displayed within Modules/AppModule.

This documentation folder is not uploaded to GitHub because you can create it automatically from the source.