If You have a firebase project, You can easily recreate and launch your own help API by cloning/forking this repository. Never commit your firebase admin json file.
You will need to have nodeJS and NPM installed on your local machine. To deploy it, You will need to have a firebase project.
To run the project locally you will need to copy your firebase admin-sdk in the root folder and name it admin-sdk.json
.
After that install and run the project with the scripts founds in package.json
npm install
npm run start
There is no hot-reload incorporated. You will need to restart the project after every change You make.
No tests at this stage yet.
Deployment steps are defined in the .circleci/config.yml
,
- Node JS - JS on server
- Express JS - Minimalistic nodeJS framework
- Firebase functions - Google serverless functions
- Function framework - Local development helper
- Circle CI - Easy integration to CI/CD