Skip to content

jackamrl/worldwide-news-app

Repository files navigation

WorldwideNewsApp

This is an opensource project that allows you to receive news and announcements from around the world in real time.

Data from NewsCatcher. They provide us with a free API

This project was generated with Angular CLI version 14.2.1.

Development server

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

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 a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

API

Newscatcher is the api we use. Here is the documentation of newscatcher api the documentation. Please use api calls sparingly, as we're only allowed one call quota.

Further help

Contributing

Thank you for considering contributing to WorldwideNewsApp! To contribute, follow these steps:

  1. Fork the repository and clone it locally.
  2. Create a new branch for your feature or bug fix.
  3. Implement your changes and add appropriate test cases.
  4. Run the existing tests using ng test to make sure your changes don't break anything.
  5. Commit your changes and push the branch to your forked repository.
  6. Open a pull request to the main repository, describing your changes in detail.

Please make sure to follow our contribution guidelines and respect our code of conduct.

Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the issue tracker.

License

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.