Skip to content

codeforamerica/surveyjs-starter-app-angular

 
 

Repository files navigation

ng# SurveyjsAngularHelloworld

This project was generated with Angular CLI version 17.0.2.

Build

Run npm install to load the package dependencies.

Then run ng build to build the project.

Development server

  1. Set up local environment variables. Run cp src/environments/environment.template src/environments/environment.ts and cp src/environments/environment.template src/environments/environment.development.ts. If you don't want to use Mixpanel for analytics, there is nothing else you need to do since it's disabled by default. If you want to configure Mixpanel, read the Third-party integrations section.
  2. Run ng serve for a dev server. Navigate to http://localhost:4200/. The application 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.

Third-party integrations

This project supports using Mixpanel for analytics. Using Mixpanel is optional and can be configured with the useMixpanel environment variable, which is a boolean. If you do decide to use Mixpanel, you should create a new Mixpanel project. In the Mixpanel console, go to Settings > Project Settings and retrieve the project token. You should add this token in the mixpanelToken variable and set useMixpanel to true. Different Mixpanel projects should be created for production and development.

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 a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

TODO

  1. Markdown (DONE)
  2. PDF Output using SurveyJS PDF Generator (DONE)
  3. Multi language support (DONE)
  4. Input masking (DONE)
  5. Custom icons (DONE)
  6. CfA Styling (IN PROGRESS)
  7. Autocomplete (IN PROGRESS)
  8. Address validation
  9. Deploy app to AWS (S3 bucket)
  10. Document upload to S3
  11. Transifex
  12. Dependent dropdowns
  13. Accessibility testing
  14. Browser compatibility
  15. Add multi language content
  16. Server side rendering (requires back end server - assumes node.js)

About

Surveyjs Angular Starter App

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 85.0%
  • CSS 12.9%
  • HTML 2.1%