[TEMPLATE] - GCP + Node.js + Firestore | Cloud

[Abhishek-Mallick]

What domain will the project template be based on?

Others (please specify in the details)

If 'Others', please specify the preferred domain.

Cloud

Particular directory path for the template.

templates/Cloud/GCP-Node.js-Firestore/

What tech stacks do you want to include?

Node.js, Express.js, Google Cloud Platform, Firestore, Firebase Authentication

Brief Description

This template should set up a Node.js Express application integrated with Google Cloud Firestore, a scalable NoSQL database. It includes user authentication via Firebase Authentication for secure user management. The project demonstrates how to perform CRUD operations on Firestore collections and documents, and how to handle real-time data updates.

Key Features:

1. User Authentication: Implement Firebase Authentication for email/password and Google Sign-In methods.
2. Firestore Integration: Set up Firestore as the database with examples of CRUD operations.
3. Real-Time Updates: Demonstrate real-time data synchronization using Firestore listeners.
4. API Endpoints: Create RESTful API endpoints for interacting with the database.
5. Deployment Scripts: Include configurations for deploying to Google App Engine.
6. Environment Configuration: Use .env files for managing environment variables securely.

Ideal workflow:

• Set up the project structure with Express.js following best practices.
• Implement middleware for Firebase Authentication.
• Create sample routes demonstrating CRUD operations with Firestore.
• Write comprehensive documentation in the README, including setup and deployment instructions.
• Include example tests using Jest for API endpoints.
• Ensure code adheres to style guidelines and includes comments for clarity.
• Create a corresponding markdown for populating docs in website/content/Templates/Cloud/GCP-Node.js-Firestore.md .. refer to this one for getting an idea on the format to follow

👀 Have you spent some time checking if this issue has been raised before?

• Yes
• No

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Would you like to work on this issue?

No