https://github.com/jakesaintg/charactersearch
An Angular application for searching and adding people to the PeopleAPI (github.com/JakeSaintG/PeopleAPI).
https://github.com/jakesaintg/charactersearch
angular hacktoberfest hacktoberfest2021
Last synced: about 1 month ago
JSON representation
An Angular application for searching and adding people to the PeopleAPI (github.com/JakeSaintG/PeopleAPI).
- Host: GitHub
- URL: https://github.com/jakesaintg/charactersearch
- Owner: JakeSaintG
- Created: 2021-08-31T01:47:42.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-03-27T19:14:28.000Z (about 4 years ago)
- Last Synced: 2023-03-05T22:16:52.315Z (over 3 years ago)
- Topics: angular, hacktoberfest, hacktoberfest2021
- Language: TypeScript
- Homepage:
- Size: 452 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CharacterSearch
## _An Angular Project_
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.2.3.
[](https://travis-ci.org/joemccann/dillinger)
## Dependencies
- Node and NPM are need to run and build the Angular application.
- Angular Command Line Interface
## Build
Run the below command to build the project.
```sh
ng build
```
## To Run
- Navigate to your terminal of choice (PowerShell, Git Bash, and Visual Studio were all tested)
- Enter the below line:
```sh
npm start
```
- The CharacterSearch application is now hosted on "http://localhost:4200/"
- Use "CTRL+C" to quit
- Run the below line to execute the unit tests via [Karma](https://karma-runner.github.io):
```sh
ng test
```
## Examples using the search feature
- "paul"
-- Will pull and display information on Paul McCartney and Paul Revere
- "mccartney"
-- Will pull and display information on just Paul McCartney
- Leaving the form blank will pull information on all characters stored in the CharacterAPI
- If you entered a person, you should be able to retrieve information on that person by entering their name.
## Examples using the "Add a person" form
- Fill in the form that appears when "Add Character" is clicked.
- Submit the form to POST to CharacterAPI
- You should then be able to retrieve the information by seraching for the person that you added!
## Special Thanks
- Health Catalyst for the chance to learn so much from this challening coding assessment!
- Peter McClanahan and Robyn Cute for answering my questions!
## Known Issues
- Sending images works but sends 200 back from the API as an error code
## Areas of Improvement
- Showing a success notification if the person data was uploaded successfully.
- Utilizing Angular's ReactiveFormsModule to create the form for adding a person.
- Deliving deeper in the features of Angular and refactoring.