theaiscope / GDD-backend

repository to host backend functionality for the GDD apps

GDD-backend

Repository to host backend functionality for the GDD-webapp.

The backend is based on a serverless architecture using Firebase Cloud Functions.

Testing, formatting and linting

Switch to the functions directory (javascript project source) before running the commands.

cd functions

To run the tests:

yarn test

The test script will setup and start the Firebase Emulator and use Jest as the test runner.

To run linting:

yarn lint

To auto format use prettier:

yarn prettier --write .

Deployment

The functions are deployed via github actions.

When changes are merged to main then the functions are deployed using the firebase-cli action to the different firebase projects

Contributing Guidelines

Contributions should be made by creating a fork of the repository and then make a PR against main. Maintainers of the project can then review and merge these PRs.