Skip to content

Prathameshjain/BeamDrop

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 

Repository files navigation

BeamDrop

📌 Overview

BeamDrop is a backend application designed to handle user registrations and manage database connections efficiently. It is built using Node.js, Express.js, and MongoDB.

📂 Project Structure

beamdrop/
│── Backend/
│   ├── app.js                # Main server file
│   ├── package.json          # Project dependencies
│   ├── package-lock.json     # Dependency lock file
│   ├── database/
│   │   └── conn.js           # Database connection setup
│   ├── models/
│   │   └── registration.js   # Mongoose schema for user registration
│   └── node_modules/         # Installed dependencies

🚀 Getting Started

1️⃣ Prerequisites

Make sure you have the following installed:

  • Node.js (v14+ recommended)
  • MongoDB (local or cloud instance)

2️⃣ Installation

Clone the repository and install dependencies:

git clone https://github.com/nesarw/nesarw-beamdrop.git
cd nesarw-beamdrop/Backend
npm install

3️⃣ Database Setup

Configure your MongoDB database connection inside database/conn.js:

const mongoose = require('mongoose');

mongoose.connect('your_mongodb_connection_string', {
    useNewUrlParser: true,
    useUnifiedTopology: true
}).then(() => {
    console.log('MongoDB Connected');
}).catch(err => {
    console.error('MongoDB Connection Error:', err);
});

4️⃣ Running the Application

Start the backend server:

node app.js

Or, if using nodemon:

npm install -g nodemon
nodemon app.js

The server should be running on http://localhost:3000.

📌 API Endpoints

Method Endpoint Description
POST /register Registers a new user

📜 License

This project is licensed under the MIT License.

🤝 Contributing

Feel free to submit pull requests or open issues to improve this project.


Star this repo if you find it useful!


This `README.md` provides:
- A clear **overview** of the project
- **Project structure** for easy navigation
- **Installation and setup instructions**
- **API endpoints** reference
- Contribution guidelines

You can copy and paste this directly into your GitHub repository. Let me know if you need modifications! 🚀

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors