Quizki Frontend

Quizki is a question and answer database which generates exams. This is the frontend of the project. For the backend go to team-quizki/backend.

This project was generated with Angular CLI version 6.0.1.

Getting Started

Here is what you need to do to get the project up and running on your local machine for development and testing purposes.

Dependencies

To run the frontend you will need to install the following tools, on your own, and before proceeding...

• Node Package Manager (npm
• Angular Command Line Interface (Angular CLI)

Installation

To get the frontend running on your local machine follow these steps.

1. Fork quizki-frontend.git into your git remote account: https://github.com/team-quizki/quizki-frontend.git
2. On your local machine create a folder to clone your forked copy into.
3. From that folder's command line issue: $ git clone https://github.com/YOUR-GIT-REMOTE/quizki-frontend.git
4. Change to the quizki-frontend directory. $ cd quizki-frontend
5. Run npm install to install packages and dependencies required by this Angular project $ npm install

If the above steps worked, you should be ready to serve the app.

Development Server

Run $ ng serve for a dev server, and navigate to http://localhost:4200/. You can also run $ ng serve --open to serve the app and open it in a new browser tab automatically. The app will automatically reload if you change any of the source files.

If $ ng serve is not working run $ npm link, and then run $ ng serve again.

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 the Tests

We have a couple simple tests built.

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.

Deployment

The project is not yet ready for deployment. We will add additional notes about how to deploy this on a live system when it is ready.

Built With

• Angular CLI

Getting Involved

This is a project of the Denver Mock Programming Job group. Find us at our Meetup page. We use the Agile development process. We want to help you gain professional coding experience.

Contributing

Please read [CONTRIBUTING.md] for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

This project is in alpha version.

Authors

• Johnathan
• Jim
• Deborah
• Jeremiah
• Nabil

License

The templated code is licensed by Google under an MIT-style License. Documentation licensed under CC BY 4.0.

The team-quizki project is licensed under the GNU GENERAL PUBLIC LICENSE. The project originated from the quizki project copyright by Johnathan James. The purpose of the team-quizki open source project is to modernize quizki.

Acknowledgements

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

LICENSE

The templated code is licensed by Google under an MIT-style License. Documentation licensed under CC BY 4.0.

The team-quizki project is licensed under the GNU GENERAL PUBLIC LICENSE. The project originated from the quizki project copyright by [Johnathan James] (https://github.com/haxwell). The purpose of the team-quizki open source project is to modernize quizki.

Join team-quizki coding an Open Source project!

To join the team-quizki project, which you are encouraged to do, look on Meetup.com for the [Denver Mock Programming Job] (https://www.meetup.com/Denver-Mock-Programming-Job-Meetup/) meetings. We use the agile development process. We want to help you gain professional coding experience.