Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions bmvBackend/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ─── Database ───────────────────────────────────────────────
DB_HOST=localhost
DB_PORT=5432
DB_USER=postgres
DB_PASS=
DB_NAME=bookmyvenue

# ─── App ────────────────────────────────────────────────────
PORT=5000
NODE_ENV=development
CORS_ORIGIN=http://localhost:3000
56 changes: 56 additions & 0 deletions bmvBackend/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
4 changes: 4 additions & 0 deletions bmvBackend/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"singleQuote": true,
"trailingComma": "all"
}
64 changes: 64 additions & 0 deletions bmvBackend/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# 🤝 Contribution Guidelines

We are building BookMyVenue in **4 Phases** to ensure a structured and community-driven approach:

### 🚀 Phase 1: The MVP (Current Phase)
Our immediate goal is to explore different approaches to building the Minimum Viable Product (MVP).
- **Open Stack:** During this phase, **anyone can contribute a base MVP using any tech stack**.
- You aren't just submitting a single feature or component—you are submitting the foundational base for the project! We encourage using a **Monorepo structure** (where your frontend and backend microservices are organized in folders within the single repository). It doesn't need to be perfect or fully featured, but it should cover the basic core flow end-to-end. We will review all submissions and merge the best one(s) to serve as our starting point.

### 🧩 Phase 2 & 3: Feature Implementation & Modularization
Once the MVP is solid, we will shift focus to expanding features and refining the architecture.
- Implementing features module by module.
- Refactoring and modularizing code to ensure it is clean, maintainable, and reusable.
- Standardizing the tech stack based on community consensus from Phase 1.

### 🌐 Phase 4: Fully Scalable Solution
The final phase focuses on scale and performance.
- Transitioning to a fully scalable product.
- Optimizing databases, adding caching layers, and handling high concurrent traffic.

## 🛠️ How to Contribute

We follow the standard open-source **Fork & Pull Request** workflow. Just follow these steps:

### Step 1: Fork and Clone the Repository
1. Click the **Fork** button at the top right of this page to create a copy of this repository in your GitHub account.
2. Clone your forked repository to your local machine:
```bash
git clone https://github.com/<your-username>/BookMyVenue.git
cd BookMyVenue
```

### Step 2: Create a Branch
Always create a new branch for your work. Do not make changes directly on the `main` branch.
Give your branch a descriptive name so we know what you are working on.
```bash
git checkout -b feat/<branch-name>
```
*(Other prefixes you can use: `fix/`, `docs/`, `chore/`)*

### Step 3: Work and Commit
1. Make your code changes or additions.
2. Test your changes locally.
3. Commit your changes with a clear and concise commit message:
```bash
git add .
git commit -m "Add: <branch-name>"
```

### Step 4: Push and Create a Pull Request (PR)
1. Push your branch to your forked repository on GitHub:
```bash
git push origin feat/<branch-name>
```
2. Go to the original BookMyVenue repository. You should see a prompt to **Compare & pull request**. Click it!
3. Provide a clear description in your PR of what you changed, why, and which phase it belongs to.
4. Submit the PR.

---

### Need Help?
If you're stuck or have questions about where to start, feel free to open an Issue and ask the community. We're here to help!

Happy Coding! 🎉
21 changes: 21 additions & 0 deletions bmvBackend/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 WeCode Org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
48 changes: 48 additions & 0 deletions bmvBackend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# BookMyVenue (by WeCode)

BookMyVenue is a 100% open-source initiative built by the **WeCode community**, designed to simplify the process of finding and booking venues in local areas. This is a platform built for the community, by the community. Whether you're looking for a cozy cafe for a quick meetup, a spacious auditorium for a community event, or a scenic outdoor space for a personal celebration, BookMyVenue aims to connect people with the perfect space—without the commercial overhead.

## 🚧 The Problem

Organizing an event—big or small—often comes with the hassle of finding a suitable location. Traditionally, people struggle with:

- **Fragmented Information:** Venue details, availability, and pricing are scattered across various websites or require time-consuming phone calls.
- **Lack of Transparency:** Hidden costs, unclear amenities, and outdated photos make it hard to trust what you are booking.
- **Time Inefficiency:** Manually comparing options, negotiating, and finalizing bookings is a tedious and frustrating process for organizers.
- **Underutilized Spaces:** Owners of small or unique spaces (like local cafes, art studios, or boutique halls) often lack the marketing reach to showcase their venues to a wider audience.

## 💡 The Solution

BookMyVenue acts as a completely free and open bridge between space owners and the community, offering a seamless booking experience for everyone:

- **Centralized Marketplace:** A single platform to discover a wide variety of venues, ranging from conventional banquet halls and auditoriums to unconventional spaces like cafes, studios, and mall pop-up spaces.
- **Real-Time Availability & Pricing:** Transparent access to schedules and upfront pricing so you can make informed decisions quickly without the back-and-forth.
- **Detailed Listings:** High-quality photos, comprehensive amenity lists (e.g., Wi-Fi, parking, AV equipment), and verified user reviews.
- **Simplified Booking Process:** Easy, hassle-free online reservations in just a few clicks.
- **Empowering Local Communities:** Providing small venue owners, community centers, and local spaces an open platform to manage their underutilized spaces and share them with the public.

## 🗺️ Project Roadmap

We are building BookMyVenue iteratively through **4 Phases**:
- **Phase 1: MVP (Current):** Anyone can contribute in *any stack*. If it's good, we merge it!
- **Phase 2 & 3: Feature & Modularization:** Implementing features module by module and refining the architecture.
- **Phase 4: Scalability:** Building a fully scalable, cloud-native solution for high traffic.

## 🤝 How to Contribute

This is a collective effort, and everyone in the WeCode community shares the benefits of what we build! Whether you're a beginner or a pro, we would love your help.
Please check out our full [Contribution Guidelines](CONTRIBUTING.md) to learn how to:
- Fork and clone the repository.
- Create your feature branch (`feat/<branch-name>`).
- Submit a Pull Request.

### 📝 Pull Request Format
To maintain a high standard of code, all Pull Requests must use our [standard template](.github/PULL_REQUEST_TEMPLATE.md). When you open a PR, you will be prompted to:
1. **Select the Phase Category** (e.g., Phase 1 MVP).
2. **Document your Tech Stack** (Frontend, Backend, Database).
3. **Complete the Review Checklist** (Self-review, community standards).
4. **Sign the AI Disclosure** (Confirming you have reviewed any AI-generated code).
5. **Attach Screenshots** (If your PR includes UI changes).

**BookMyVenue belongs to all of us. Join WeCode today and let's build something amazing together!**
love to contribute
35 changes: 35 additions & 0 deletions bmvBackend/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// @ts-check
import eslint from '@eslint/js';
import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
import globals from 'globals';
import tseslint from 'typescript-eslint';

export default tseslint.config(
{
ignores: ['eslint.config.mjs'],
},
eslint.configs.recommended,
...tseslint.configs.recommendedTypeChecked,
eslintPluginPrettierRecommended,
{
languageOptions: {
globals: {
...globals.node,
...globals.jest,
},
sourceType: 'commonjs',
parserOptions: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
},
},
{
rules: {
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-floating-promises': 'warn',
'@typescript-eslint/no-unsafe-argument': 'warn',
"prettier/prettier": ["error", { endOfLine: "auto" }],
},
},
);
8 changes: 8 additions & 0 deletions bmvBackend/nest-cli.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src",
"compilerOptions": {
"deleteOutDir": true
}
}
Loading