Skip to content

implemented bmv#73

Open
GokulShaji2005 wants to merge 16 commits into
WeCode-Community-Dev:mainfrom
GokulShaji2005:main
Open

implemented bmv#73
GokulShaji2005 wants to merge 16 commits into
WeCode-Community-Dev:mainfrom
GokulShaji2005:main

Conversation

@GokulShaji2005

Copy link
Copy Markdown

This pull request sets up the foundational structure for the BookMyVenue backend using NestJS. It introduces initial configuration, code quality tools, and the core modules for authentication, user, venue, and booking management, along with basic documentation and contribution guidelines. The codebase is structured for modularity, scalability, and community collaboration.

The most important changes are:

Project Setup & Configuration

  • Added initial project configuration files, including package.json with scripts and dependencies, .env.example for environment variables, and nest-cli.json for NestJS project settings. [1] [2] [3]
  • Added .gitignore to exclude build outputs, environment files, logs, and IDE settings.
  • Added code formatting and linting configuration with Prettier (.prettierrc) and ESLint (eslint.config.mjs). [1] [2]

Core Application Structure

  • Implemented the main application module (app.module.ts), controller, and service, and set up global modules for configuration, rate-limiting, and scheduling. [1] [2] [3]
  • Established modular structure with initial modules for authentication, users, venues, booking, database, and cloudinary integration. [1] [2]

Authentication System

  • Developed a comprehensive authentication module with endpoints for OTP-based login, credential login, token refresh, and logout, including rate-limiting for security. [1] [2]
  • Added DTOs, entities, and test files for the authentication flow. [1] [2]

Documentation & Community Guidelines

  • Added a detailed README.md explaining the project vision, problem statement, solution, and contribution process.
  • Added CONTRIBUTING.md with step-by-step guidelines for new contributors and a phased development roadmap.
  • Included a LICENSE file (MIT License) for open-source usage.

Testing

  • Added basic unit test files for controllers and services to ensure initial test coverage and provide examples for future tests. [1] [2] [3]

This establishes a solid foundation for further development and community contributions to BookMyVenue.## Description

Phase Category

  • Phase 1: MVP Submission (Base Foundation)
  • Phase 2/3: Feature Implementation or Modularization
  • Phase 4: Scalability Optimization
  • General (Documentation, Bugfix, Chore, etc.)

Tech Stack (For Phase 1 MVP Submissions)

(Example: Frontend: React, Backend: Node.js, Database: MongoDB)

  • Frontend: Nextjs with tailwind css, Shadcn Ui components
  • Backend: Nestjs with Typeorm
  • Database: Postgresql

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature / Module (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist:

  • I have read the Contribution Guidelines.
  • My code follows the community spirit and standards of the WeCode community.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generate no new warnings or errors.

AI Disclosure

  • I did NOT use AI tools to generate this code.
  • I used AI tools (e.g., Copilot, ChatGPT, Claude) to help write this code, and I have fully reviewed, tested, and understand the output.

Screenshots / Screen Recording (if applicable)

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.

1 participant