Skip to content

Biblink/biblink-frontend

Repository files navigation

Biblink Logo

Biblink Frontend

CircleCI Conventional Commits

Made with Bulma

Authors: Brandon Fan, Jordan Seiler, Jonathan Fan

TODO List

  • Implement user types: Administrator & Study Leaders
  • Continue implementing dashboard features
  • Implement highlighting in the shared Bible

Resources

Frontend Required Pages: Link to Doc

Frontend Invision Designs: Link to Invision

Installing Dependencies

Run npm install to install all third-party dependencies.

Using External JavaScript Code

  1. Add script to ./src/assets/external-code/js/
  2. Add /assets/external-code/js/<name-of-file>.js to .angular-cli.json in the scripts array:
{
  "app": [
    {
      "scripts": ["/assets/external-code/js/<name-of-file>.js"]
    }
  ]
}
  1. Rerun ng serve --aot

Use in Typescript

  1. Go into associated .ts file and add after imports:
declare const <corresponding-symbol-to-js-file>: any;

Development server

Run ng serve --aot for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Generating New Pages/Code Scaffolding

Run ng generate component component-name to generate a new component (page). You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build For Production

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.