https://github.com/gbrowns/inventory-api-firebase
demistifying cloud functions with firebase
https://github.com/gbrowns/inventory-api-firebase
api express firebase firebase-emulators firebase-functions serverless-functions
Last synced: 6 months ago
JSON representation
demistifying cloud functions with firebase
- Host: GitHub
- URL: https://github.com/gbrowns/inventory-api-firebase
- Owner: gbrowns
- Created: 2023-02-13T15:52:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T14:07:07.000Z (over 2 years ago)
- Last Synced: 2025-02-04T12:52:03.327Z (8 months ago)
- Topics: api, express, firebase, firebase-emulators, firebase-functions, serverless-functions
- Language: JavaScript
- Homepage:
- Size: 98.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Express-Firebase-API
A simple express api, that utilizes firebase cloud functions & firestore and performs CRUD operations
- Uses firebase local emulator suite.
### Environment
- Ubuntu LTS
### Tools
1. Firebase Cloud Firestore
2. Firebase Local Emulator Suite
3. Firebase Cloud Function
4. Expressjs
# Setup
1. Clone the following repository to local machine
- `git clone https://github.com/Godwin254/inventory-api-firebase/`
2. Navigate to the project folder
- `cd inventory-api-firebase`
3. Navigate to the functions directory
- `cd functions`
4. Install all dependencies
- `npm install`
5. Start the firebase emulator
- `npm run serve`
6. Visit the generated functions url to send requests to the inventory endponts
- `GET functions_url/inventories` - retrieves all inventories
- `GET functions_url/inventories/id` - retrieves a single inventory
- `POST functions_url/inventories` - creates an inventories
- `PUT functions_url/inventories/id` - updates a single inventory
- `DELETE functions_url/inventories` - delete a single inventory
Chech the [postman documentation](https://documenter.getpostman.com/view/14678284/2s93CEwwXo)