This is an Angular app which displays data and allows for the use of user-defined filters.
This app displays data retrieved from an API. This app gives the ability to extensively fiter through the data and also view a single piece of data.
This project was generated with Angular CLI version 12.2.12.
Yarn required for executing the scripts below. If you don't have it installed be run the command below:
npm install --global yarn
Run yarn start
to start both the frontend and backend development servers.
Navigate to http://localhost:4200/
for the frontend app. The app will automatically reload if you change any of the source files.
Navigate to http://localhost:5000/
for the backend server.
Run yarn test
to run tests on the app.
Run yarn frontend
to start only the frontend development server.
Navigate to http://localhost:4200/
for the frontend app. The app will automatically reload if you change any of the source files.
Run yarn backend
to start only backend development server then avigate to http://localhost:5000/
.
Run yarn doc
to generate project documentation.
This app uses a couple of external libraries/tools;
- Bootstrap - CSS framework for styling
- JSON Server - Full fake REST API for the backend. Data supplied to the frontend can be changed by updating the
db.json
file. - Compodoc - Documentation generation tool
- Cucumber - Behavior-Driven Development (BDD) testing toolkit.
Below are a couple of enhancements/todos identified;
- Mobile friendly version - Although bootstrap was used in development, a more mobile friendly version should be considered.
- Higher Test Coverage