Skip to content

Conversation

@adgator101
Copy link
Contributor

This pull request adds comprehensive API documentation for several endpoints and updates environment and workflow configuration files. The main changes include new or expanded documentation for member, project, event, and image upload APIs, as well as improvements to testing workflows and environment variable templates.

API Documentation Additions and Improvements

Member APIs

  • Added documentation for creating a member (CREATEMEMBER.md), including request/response formats, error handling, and notes on field validation.
  • Added documentation for listing members with pagination and error handling (LISTMEMBER.md).
  • Added documentation for updating member details, describing request structure, authorization, and error responses (UPDATEMEMBER.md).

Project APIs

  • Added documentation for creating, updating, listing, and deleting projects, with detailed request/response formats and error handling (CREATEPROJECT.MD, UPDATEPROJECT.MD, LISTPROJECT.MD). [1] [2] [3]

Event APIs

  • Added documentation for listing events and fetching event details, including example success and error responses (LISTEVENT.md, GETEVENT.md). [1] [2]

Image Upload

  • Added documentation for uploading images to Cloudinary, including setup, implementation examples, and request/response formats (CLOUDINARY_UPLOAD.md).

Workflow and Environment Configuration

Testing Workflow

  • Added a new GitHub Actions workflow for running endpoint tests using Vitest, with instructions for local testing using Docker and act (test.yml, README.md). [1] [2]

Environment Variables

  • Updated .env.example to include new environment variables required for authentication and GitHub integration (NODE_ENV, JWT_ACCESS_SECRET, JWT_REFRESH_SECRET, GITHUB_TOKEN).

These changes collectively improve developer experience by providing clear API usage instructions, error handling expectations, and standardized testing and environment setup procedures.

Aayush0966 and others added 29 commits September 19, 2025 03:02
feat: integrate cloudinary for image uploads
feat: enhance member management with query validation and retrieval f…
…orToProject and improve error handling for contributor creation
Introduced Project Functionality with github API implementation
updated pnpm lock file for github actions for tests and disabled signin test for now
@adgator101 adgator101 merged commit 65a41c6 into main Sep 24, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants