https://github.com/adityassharma-ss/data-collection-platform
A comprehensive data collection platform designed to streamline response processing and enhance post-submission business logic
https://github.com/adityassharma-ss/data-collection-platform
backend backend-api docker expressjs mongodb
Last synced: 3 months ago
JSON representation
A comprehensive data collection platform designed to streamline response processing and enhance post-submission business logic
- Host: GitHub
- URL: https://github.com/adityassharma-ss/data-collection-platform
- Owner: adityassharma-ss
- Created: 2023-11-22T14:25:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-22T17:58:24.000Z (over 2 years ago)
- Last Synced: 2025-01-21T10:50:50.722Z (over 1 year ago)
- Topics: backend, backend-api, docker, expressjs, mongodb
- Language: JavaScript
- Homepage:
- Size: 483 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Data Collection Platform
The Data Collection Platform is a robust system designed for collecting and managing responses across multiple organizations and use cases. This README provides an overview of the project, its components, and instructions on how to set up and run the application.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Endpoints](#endpoints)
- [Google Sheets Integration](#google-sheets-integration)
- [Testing](#testing)
- [Monitoring and Logging](#monitoring-and-logging)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Form Creation:** Create forms with questions and metadata.
- **Response Management:** Capture and manage responses to forms.
- **Integration:** Seamless integration with Google Sheets and other potential plugins.
- **Validation:** Validate responses based on business rules.
- **SMS Integration:** Send SMS receipts to participants.
## Requirements
- Node.js (v14 or higher)
- MongoDB
- Google Sheets API Key and Service Account Credentials
- Artillery for Load Testing (optional)
## Installation
1. Clone the repository:
```bash
```
2. Navigate to the project directory:
```bash
cd data-collection-platform
```
3. Install dependencies:
```bash
npm install
```
Configuration
1. Create a .env file in the project root and configure the following variables:
```MONGODB_URI=mongodb+srv://:@/?retryWrites=true&w=majority
GOOGLE_SHEETS_API_KEY=your-google-sheets-api-key
GOOGLE_SHEETS_SPREADSHEET_ID=your-google-sheets-spreadsheet-id```
2. Create a service account in the Google Cloud Console and download the credentials file. Rename the file to `google-sheets-service-account.json` and place it in the project root.
## Usage
1. Start the application:
```bash
npm start
```
2. Navigate to http://localhost:3000 in your browser.
3. Ensure MongoDB is running and accessible.