Skip to content

Customized README.md #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akb1449 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Customized README.md #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions FlashCourse-web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,24 @@

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.7.3.

## Development server

## Running the Angular 2/5 Locally
Install NodeJS (> v4) and NPM (> v3) from https://nodejs.org/en/download/, you can check the versions you have installed by running node -v and npm -v from the command line.
Download the project source code from GitHub repository: https://github.com/unh-webappdev/FlashCourses_web.git
Install all required npm packages by running ’npm install’ from the command line in the project root folder (where the package.json is located).
Start the application by running ’npm start’ from the command line in the project root folder.

## Creating a Build / Deploying your App
We need to use the Angular CLI to create a build of our app. Hop into the console within the project folder and run the following command:
ng build --prod (to make sure that you are only doing production)
This will take 5-20 seconds to run. The end result is a new folder called /dist within the project root folder. -- prod will reduce nearly a 90% in file size. This is because the --prod flag enables a number of optimizations that drastically reduces the size of the project.
If you do ng build, it will create up to 3mb file size.


## Run a 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](https://karma-runner.github.io).

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
## Build the project
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.