https://github.com/webceyhan/ng-heroes-app
Angular Tour of Heroes Application
https://github.com/webceyhan/ng-heroes-app
angular bootstrap css github-actions heroku html javascript nodejs rest typescript
Last synced: 2 months ago
JSON representation
Angular Tour of Heroes Application
- Host: GitHub
- URL: https://github.com/webceyhan/ng-heroes-app
- Owner: webceyhan
- License: mit
- Created: 2022-01-21T11:16:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T11:44:28.000Z (over 2 years ago)
- Last Synced: 2024-05-29T19:17:51.796Z (about 2 years ago)
- Topics: angular, bootstrap, css, github-actions, heroku, html, javascript, nodejs, rest, typescript
- Language: TypeScript
- Homepage: https://ng-heroes-app.onrender.com
- Size: 2.06 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/webceyhan/ng-heroes-app/actions/workflows/github-code-scanning/codeql)
# Angular Tour of Heroes Application
This is a sample application based on the famous tutorial `Tour of Heroes` from the official Angular website, which covers many aspects of the Angular Framework.
## Requirements
You need to install the [Node.js](https://nodejs.dev/)
and `npm` package manager first.
> Recommended IDE:
> [VSCode](https://code.visualstudio.com/) + [Angular Essentials](https://marketplace.visualstudio.com/items?itemName=johnpapa.angular-essentials)
## Installation
1. Clone the repository.
```sh
git clone https://github.com/webceyhan/ng-heroes-app.git
```
2. Get inside the cloned project folder.
```sh
cd ng-heroes-app
```
3. Install NPM packages.
```sh
npm install
```
## Usage
You can use following commands to do various task with the project.
```sh
npm start # run application
npm run serve # start development server
npm run test # run test suits
npm run build # build for production
```
> Take a look at the other scripts in [`package.json`](./package.json)
## Development
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.
## Testing
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
## Building
Run `ng build` to build the project.
The build artifacts will be stored in the `dist/` directory.
Use the `--configuration production` flag for a production build.
## Deployment (Render)
Project is linked to [Render](https://render.com/) for deployment.
> It will automatically deploy the project to Render on every push.
## References
- [Node.js](https://nodejs.dev/)
- [Angular](https://angular.io/)
- [Bootstrap](https://getbootstrap.com)
- [TypeScript](https://www.typescriptlang.org)