Skip to content

Angular RSS Feed Reader for news of the German Jiu Jitsu Federation

License

Notifications You must be signed in to change notification settings

ckruhs/djjb-news-reader

Repository files navigation

License: MIT follow on Twitter

DJJB News Reader

This is a Progressive Web App to display the News Feed of the German Jiu Jitsu Federation / Deutscher Jiu Jitsu Bund (DJJB) on mobile devices. In addition, the course plan can be viewed and online registrations can be made.

Watch the App live on your mobile device here: https://www.DJJB.de/news-reader

Since the App displays a german speaking RSS Feed, the user interface is displayed in German.

Screenshot

Getting Started

The project was created with Visual Studio Code and the Angular CLI Version 8.2.

These instructions will get you a copy of the project up and running on your local machine for development purposes.

Set up the Development Environment

You need to set up your development environment first. See Angular Getting Started Guide for further information.

Install Node.js® and npm if they are not already on your machine.

Verify that you are running at least Node.js version 10.x or greater and npm version 6.x or greater by running node -v and npm -v in a terminal/console window. Older versions produce errors, but newer versions are fine.

Then install the Angular CLI globally:

npm install -g @angular/cli

Get the Code

Download or clone the repo:

git clone https://github.com/ckruhs/djjb-news-reader.git

To clone the repo, Git must of course be installed on the local computer. To set up Git please see Set Up Git for details.

Install Project dependencies

Install the necessary dependencies from the project root folder:

cd djjb-news-reader
npm install

(This will install the dependencies declared in the package.json file)

Development server

Run the dev server:

ng serve

Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Acknowledgments

The BeCompany news reader tutorial was a good starting point for the project and some code parts were taken over.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

DJJB News Reader uses several third-party libraries. More information can be found in THIRD-PARTY-NOTICES.txt.

Contributing

See the Guidelines for Contributing