Skip to content

The Francken Consumption Counter (FCC) allows our members to keep track of consumption expenses at our association.

License

Notifications You must be signed in to change notification settings

ProfessorFrancken/Consumption-Counter

Repository files navigation

Francken Consumption Counter

Jest tests End-to-end tests Coverage Status

Introduction

The consumption counter is used by T.F.V. 'Professor Francken' to keep track of food & drink purchases of its members.

The application has been boostrapped using Create React App and uses an external API for retrieving its data.

To setup the application first install its dependencies using npm,

npm install

Next check if all the test pass,

npm run test

And if successful run the app,

npm run start

This will open the application in a new browser window located at https://localhost:3000.

Running cypress

We use cypress for our end-to-end tests. These tests will be run using Github actions, but can also be run locally by calling,

npm run cypress

Note: before running this command make sure that you've started the application by running npm run start.

This will open a user interface listing all of our integration tests, which you can run by clicking "Run all specs".

Using an alternative (persisting) server

By default we use miragejs to develop and test the application. This means that each time you start the application a new in-memory database is initialized.

TODO Discuss all API endpoints

The Consumtion Counter requires the following endpoints

POST /authenticate

POST /orders

GET /members

GET /products

GET /committees

GET /boards

GET /statistics/categories

GET /statistics/activities

Using docker

If you don't want to install npm locally you can use docker instead to install and run the application,

# First install dependencies
docker-compose run --rm node npm install

# Check if all unit tests pass
docker-compose run --rm node npm test

# Start the node server at port 30000
docker-compose up

About

The Francken Consumption Counter (FCC) allows our members to keep track of consumption expenses at our association.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6