Documentation - BackendForge

Quick Start Guide

1. Describe Your Project

Go to the Generator page and describe your project in detail. The more specific you are, the better our AI can understand your needs.

2. Choose Features

Select the features you need or let our AI suggest them based on your description. Features include user management, WebSocket support, AI integration, and more.

3. Generate & Download

Click generate and wait 10-30 seconds. Download the enhanced bundle for the best experience, including setup scripts and comprehensive documentation.

Generated Project Structure

my-project/
├── src/
│   ├── controllers/          # API route handlers
│   ├── models/              # Database models
│   ├── routes/              # Express routes
│   ├── middleware/          # Custom middleware
│   ├── services/            # Business logic
│   ├── utils/               # Helper functions
│   └── config/              # Configuration files
├── tests/                   # Test files
├── docs/                    # Documentation
├── logs/                    # Log files
├── package.json             # Dependencies
├── .env.example             # Environment variables
├── Dockerfile               # Docker configuration
├── docker-compose.yml       # Docker Compose
├── quick-start.sh           # Setup script (Linux/Mac)
├── quick-start.bat          # Setup script (Windows)
└── README.md                # Project documentation

Setup Instructions

Enhanced Bundle (Recommended)

The enhanced bundle includes automatic setup scripts:

Linux/Mac ./quick-start.sh

Windows quick-start.bat

Manual Setup

Extract the downloaded ZIP file
Run npm install
Copy .env.example to .env
Configure your database connection in .env
Run npm run dev to start development

API Documentation

Every generated backend includes interactive API documentation powered by Swagger UI.

After starting your server, visit http://localhost:3000/docs to explore your API endpoints interactively.

Deployment Options

Google Cloud Platform

Ready-to-deploy with included app.yaml configuration.

gcloud app deploy

Docker

Containerized deployment with Docker and Docker Compose configurations.

docker-compose up

Frequently Asked Questions

What's the difference between Basic ZIP and Enhanced Bundle?

The Enhanced Bundle includes setup scripts, comprehensive documentation, code quality tools (ESLint, Prettier), testing framework setup, and deployment configurations. The Basic ZIP contains just the core generated code.

Can I modify the generated code?

Absolutely! The generated code is yours to modify, extend, and customize. It's designed to be a solid foundation that you can build upon.

What databases are supported?

Currently, we support MongoDB (NoSQL) and PostgreSQL (SQL). The generated code includes optimized schemas, connection pooling, and database-specific best practices.

Is the generated code production-ready?

Yes! The generated backends include security features, error handling, logging, testing setup, and deployment configurations. However, you should review and customize the code for your specific production requirements.