Merge pull request #31 from DataSeer/add_version

Add version

Author: NicolasKieffer

.eslintrc.js

@@ -1,4 +1,4 @@
-// .eslintrc.js
+// File: .eslintrc.js
 module.exports = {
   env: {
     node: true,

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit 

.husky/post-tag

@@ -0,0 +1,14 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# Extract version from tag
+VERSION=$(git describe --tags --abbrev=0)
+# Remove 'v' prefix if present
+VERSION=${VERSION#v}
+
+# Update package.json version
+npm version $VERSION --no-git-tag-version --allow-same-version
+
+# Stage and commit package.json changes
+git add package.json
+git commit -m "chore: update package.json version to $VERSION" --no-verify

.versionrc.json

@@ -0,0 +1,23 @@
+{
+  "types": [
+    { "type": "feat", "section": "Features" },
+    { "type": "fix", "section": "Bug Fixes" },
+    { "type": "docs", "section": "Documentation" },
+    { "type": "style", "section": "Styling" },
+    { "type": "refactor", "section": "Code Refactoring" },
+    { "type": "perf", "section": "Performance Improvements" },
+    { "type": "test", "section": "Tests" },
+    { "type": "build", "section": "Build System" },
+    { "type": "ci", "section": "Continuous Integration" },
+    { "type": "chore", "section": "Chores" }
+  ],
+  "commitUrlFormat": "https://github.com/DataSeer/snapshot-api/commits/{{hash}}",
+  "compareUrlFormat": "https://github.com/DataSeer/snapshot-api/compare/{{previousTag}}...{{currentTag}}",
+  "releaseCommitMessageFormat": "chore(release): {{currentTag}}",
+  "skip": {
+    "bump": false,
+    "changelog": false,
+    "commit": false,
+    "tag": false
+  }
+}

CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2024-01-09
+
+### Features
+- PDF document processing integration with GenShare API
+- JWT-based authentication system for all routes
+- Role-based access control with allow/block lists per route
+- User-specific rate limiting with configurable thresholds
+- AWS S3 integration for complete request traceability
+- Google Sheets integration for summary logging
+- Health monitoring for all dependent services (GenShare, GROBID, DataStet)
+- Comprehensive logging system with Winston and Morgan
+- Script-based user and permissions management
+
+### Security
+- JWT authentication required for all routes
+- Route-specific access control through permissions system
+- Secure token storage and management
+- User-specific rate limiting to prevent abuse
+- Complete request traceability in S3 storage
+
+### Added
+- Command-line tools for user management
+- Command-line tools for permission management
+- Log analysis utilities
+- Health check endpoints for all services
+- Automated S3 storage for all processing requests
+- Google Sheets integration for process tracking
+- Docker support with multi-stage builds
+- CI/CD workflows for development and production
+
+### Documentation
+- Complete API documentation
+- Installation and configuration guides
+- Deployment instructions
+- Security considerations
+- Contributing guidelines
+- Script usage examples
+
+[1.0.0]: https://github.com/DataSeer/snapshot-api/releases/tag/v1.0.0

Dockerfile

@@ -16,14 +16,14 @@ COPY . .
 
 # Copy default files if originals don't exist
 RUN if [ ! -f .env ]; then cp .env.default .env || true; fi && \
-    if [ ! -f conf/users.json ]; then mkdir -p conf && cp conf/users.json.default conf/users.json || true; fi && \
-    if [ ! -f conf/permissions.json ]; then mkdir -p conf && cp conf/permissions.json.default conf/permissions.json || true; fi && \
+    if [ ! -f conf/aws.s3.json ]; then mkdir -p conf && cp conf/aws.s3.json.default conf/aws.s3.json || true; fi && \
     if [ ! -f conf/datastet.json ]; then mkdir -p conf && cp conf/datastet.json.default conf/datastet.json || true; fi && \
-    if [ ! -f conf/grobid.json ]; then mkdir -p conf && cp conf/grobid.json.default conf/grobid.json || true; fi && \
     if [ ! -f conf/genshare.json ]; then mkdir -p conf && cp conf/genshare.json.default conf/genshare.json || true; fi && \
-    if [ ! -f conf/aws.s3.json ]; then mkdir -p conf && cp conf/aws.s3.json.default conf/aws.s3.json || true; fi && \
+    if [ ! -f conf/googleSheets.credentials.json ]; then mkdir -p conf && cp conf/googleSheets.credentials.json.default conf/googleSheets.credentials.json || true; fi && \
     if [ ! -f conf/googleSheets.json ]; then mkdir -p conf && cp conf/googleSheets.json.default conf/googleSheets.json || true; fi && \
-    if [ ! -f conf/googleSheets.credentials.json ]; then mkdir -p conf && cp conf/googleSheets.credentials.json.default conf/googleSheets.credentials.json || true; fi
+    if [ ! -f conf/grobid.json ]; then mkdir -p conf && cp conf/grobid.json.default conf/grobid.json || true; fi && \
+    if [ ! -f conf/permissions.json ]; then mkdir -p conf && cp conf/permissions.json.default conf/permissions.json || true; fi && \
+    if [ ! -f conf/users.json ]; then mkdir -p conf && cp conf/users.json.default conf/users.json || true; fi
 
 # Expose the port your app runs on
 EXPOSE 3000