https://github.com/dalenguyen/serverless-rest-api
Building RESTful Web APIs with Firebase Cloud Function, Firestore, Express and TypeScript
https://github.com/dalenguyen/serverless-rest-api
api api-server cloud-functions firebase firestore restful-api serverless
Last synced: about 2 months ago
JSON representation
Building RESTful Web APIs with Firebase Cloud Function, Firestore, Express and TypeScript
- Host: GitHub
- URL: https://github.com/dalenguyen/serverless-rest-api
- Owner: dalenguyen
- Created: 2018-06-28T00:51:55.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-19T01:19:50.000Z (over 5 years ago)
- Last Synced: 2025-03-28T21:22:08.326Z (2 months ago)
- Topics: api, api-server, cloud-functions, firebase, firestore, restful-api, serverless
- Language: TypeScript
- Homepage: https://medium.com/@dalenguyen/building-a-serverless-restful-api-with-cloud-functions-firestore-and-express-f917a305d4e6
- Size: 17.6 KB
- Stars: 110
- Watchers: 11
- Forks: 54
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Building Serverless RESTful Web APIs with Cloud Functions, Firestore, Express and TypeScript
This is a simple API that saves contact information of people.
## Requirements
[NodeJS](https://nodejs.org/en/)
You will need a Firebase project and firebase tools cli
```
npm install -g firebase-tools
```
## Getting Started
You can follow the guide on [Medium](https://medium.com/@dalenguyen/building-a-serverless-restful-api-with-cloud-functions-firestore-and-express-f917a305d4e6) or clone this repository.
## Clone this repository
```
git clone [email protected]:dalenguyen/serverless-rest-api.git .
```
You need to change the firebase project name in *.firebaserc* file.
After that, you can log in to firebase in the terminal
```
firebase login
```
## Deploy to firebase
For the first time, you have deploy the hosting and functions together
```
firebase deploy
```
After that, you just need to deploy functions only
```
firebase deploy --only functions
```
## Trouble shooting
If you have the **declare namespace FirebaseFirestore**, please comment the content of **node_modules/@google_cloud/firestore/types/firestore.d.ts**. After that you can test the api locally or deploy it to the cloud.
If you cannot do it, please "".firebaserc" has to be deleted and "firebase init" need to be run again." - Thanks to [techboycr](https://github.com/dalenguyen/serverless-rest-api/issues/1).