How crepe-party/just_bi_api works
Project type and purpose
• just_BI_api is a lightweight Node.js backend API built to manage AWS S3 buckets/objects and perform AWS Rekognition face‐detection operations.
• There is no frontend; it exposes HTTP endpoints (via server.js) that wrap the AWS S3 and Rekognition APIs, driven by a set of abstract manager classes.
File structure
• Top-level files:
• server.js – entry point, HTTP server + route wiring
• package.json, jest.config.js – dependencies & test setup
• config.json.example – runtime configuration (AWS creds, region, bucket names)
• databaseModelRIA2.sql – (present but not wired into code)
• deployement_script/deploy.sh – automates git pull & pm2 deployment
• class/ directory:
• AbstractBucketManager.js, Bucket.js – encapsulate S3 bucket operations
• AbstractDetectingFacesManager.js, DetectingFaces.js – encapsulate Rekognition calls
• test/ directory:
• Bucket.test.js, DetectingFaces.test.js – TDD unit tests using Jest/Mocha
README for additional insights
• Describes installation, configuration, test commands, start/stop scripts.
• Mentions AWS CLI commands for bucket & face detection, implying the API mirrors these operations.
• Mentions deploy.sh requirements (node, npm, git, pm2).
• Blue for application components
• Green for AWS external services
• Orange for operational/deployment tools
• Gray for configuration/test artifacts