Skip to content

ChalkDoc/generator

Repository files navigation

Generator

Angular application that allows the user to enter an equation, set parameters for variables (decimal point, minimum value, maximum value), choose the variable to sovle for, number of problems desired and then displays a table of values for each variable.

This project was generated with Angular CLI version 1.6.0.




See the Documentaion

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app 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.

Build

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.

Installation and Setup

  • Clone this repository
  • Run npm install
  • Run bower install
  • Run ng serve
  • If you get the error:
Versions of @angular/compiler-cli and typescript could not be determined.
The most common reason for this is a broken npm install.

Please make sure your package.json contains both @angular/compiler-cli and typescript in
devDependencies, then delete node_modules and package-lock.json (if you have one) and
run npm install again.

run npm install --dev and ng serve

  • If you get the error:
Your global Angular CLI version (1.6.0) is greater than your local
version (1.5.5). The local Angular CLI version is used.

run

npm uninstall --save-dev angular-cli

followed by

npm install --save-dev @angular/cli@latest

Technologies Used

Notes

  • We used hash collision probailities in order to determine how the program should obtain possible variable values.
  • Right now the guppy icons are commented out(assets/scripts/guppy.min.js line 1128). We are currently using version 1.1. May want to consider using newer version in the future.

Future Work:

  • Add integration tests.
  • Taking in additional parameters.
  • Supporting other inputs (ex. system of equations).
  • Displaying output to user specification(LaTeX).
  • Specify what the answer should look like (ex. pair, number, simplified equations)
  • Include multiple choice functionality.

Known Bugs

  • User can enter negative number for number of problems.
  • Can't take all equations (-x^2 = y)
  • In generator.service.ts max invalid counter is set to a hard coded number, however needs to be dynamic or else the results are restrictive.
  • Each variable varialble must require the same number of decimals, otherwise no solutions are generated. The program should be able to handle cases where the variables decPoint property varies.

Further Help

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

Contributors


ElreyB

📖 💻 🐛

Mitch Long

⚠️ 💻 📖 🐛

Kristen Marie Kulha

💻 📖 🐛

Kim Schulze

💻 ⚠️

mwoldemedihin

📖 💻 ⚠️ 🎨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published