functions

Welcome to TeamOneFootOutTheDoor's backend GitHub for CandorVille. If you were looking for the main GitHub, go here.

In this README, you can find useful information on the things that you can do in terms of commands in the backend. For all intents and purposes, we will assume that you are in the backend/functions directory when you are inputting these commands.

Getting Started

Make sure that you've successfully completed the Getting Started (Post-Inherit) section back from our main GitHub.

Linter

Taken from here.

It is recommended that you run the Lint tests locally so that you can make sure that your code will be passing for the CI in terms of Lint.

Run the following commands:

npm run tslint
npm run elint:summary

This will start TSLint and ESLint respectively on the frontend. You will have passed all the Lint tests if you are brought up to another command-line prompt and no errors were listed.

Auto Documentation

Taken from here.

Like with the Linter, it is recommended that you run this part locally to make sure that it will cause no errors during the CI.

Run the following commands:

npm run docs

If all goes well, it should produce a new folder called adocs in the backend/functions directory. Do not push adocs to GitHub. CI should handle that automatically if set up properly.