Skip to content

NCAR/Ozone-Interactive-Story

 
 

Repository files navigation

Ozone Interactive Story

This project was generated using Angular CLI version 20.3.8.

Node v24.15.0

Development server

To start a local development server, run:

npm start

Once the server is running, open your browser and navigate to http://localhost:4200/. The application will automatically reload whenever you modify any of the source files.

Project Layout

Inside src/app, there are 3 folders which contain the majority of our code:

  • core: for core modules, services, interfaces, etc. used throughout the app. Should contain no UI code in here.
  • features: for page components, such as the home page, play page, and scene definitions. Should loosely correspond to the associated routes in src/app/app.routes.ts. Any one-time components such as the language dropdown can live within the hierarchy here.
  • shared: for reusable components like text, buttons, etc. which are independent of the page they're on; also could include custom pipes directives, etc. if we need them

In tsconfig.json, there are paths which define @core, @features, and @shared which should be used when importing modules between the folders (e.g. don't import ../../../../core/story.service.ts, use import @core/story.service.ts)

Code scaffolding

Angular CLI includes powerful code scaffolding tools. To generate a new component, run:

ng generate component component-name

For a complete list of available schematics (such as components, directives, or pipes), run:

ng generate --help

Unit Tests

Unit tests were written for each scene component, story service, story player, and other important components. If more scenes are created, a spec file should be written and placed within the scene's directory.

To execute unit tests with the Karma test runner, use either of the following commands:

ng test or npm test

Assets

View the Project Style Guide and Project Asset Source docs under the public/docs directory to learn more about creating assets for the project.

Created by Logan Bird, Tyler Campbell, Matt Harper, Matthew Kind, Quinn Nicodemus, Linh Tran, and Charlie Wheeler in collaboration with UCAR Center for Science Education

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 60.8%
  • SCSS 21.7%
  • HTML 16.1%
  • JavaScript 1.1%
  • Other 0.3%