Abhishek-Mallick / Abhishek-Mallick/universal-box

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

Abierto
#154 0 comentarios 0 reacciones 0 asignados Ver en GitHub
hacktoberfest
Lenguaje dominante
JavaScript
Estrellas
47
Forks
41
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

### 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](https://universal-box.dev/) in `website/content/Templates/Cloud/GCP-Node.js-Firestore.md` .. refer to [this one](https://github.com/Abhishek-Mallick/universal-box/blob/main/website/content/Templates/FullStack/EJS(SSR)%2BNodejs(Backend).md) for getting an idea on the format to follow

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

- [X] Yes
- [ ] No

### 🏢 Have you read the Code of Conduct?

- [X] I have read the [Code of Conduct](https://github.com/Abhishek-Mallick/universal-box/blob/main/.github/CODE_OF_CONDUCT.md)

### Would you like to work on this issue?

No

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

The template should be created in `templates/Cloud/GCP-Node.js-Firestore/`. Start by examining the existing template at `website/content/Templates/FullStack/EJS(SSR)+Nodejs(Backend).md` to understand the required format. The work involves setting up a full Node.js Express app with Firestore integration, authentication, real-time updates, API endpoints, deployment scripts, and comprehensive documentation including a README and a corresponding markdown file for the website.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
express, firebase, google-cloud, node.js
Área
backend, cloud, documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.