Documentation
Everything you need to know about generating and running Surfside Media project scaffolds.
Getting Started
Welcome to the Surfside Media documentation. Our platform allows you to generate robust, production-ready boilerplates for a variety of web frameworks and architectures.
- Select your preferred runtime and framework from the generator tool.
- Choose the architectural pattern (e.g., MVC, REST API, JWT Auth).
- Download the generated `.zip` archive.
- Extract it and follow the
README.mdinside the downloaded project.
Running Your Project Locally
Once you extract your generated project, you will typically need to install dependencies. Here are the common commands:
- Node.js (Express/Next.js/NestJS):
npm installthennpm run dev - Python (Flask/Django):
pip install -r requirements.txtthen run the main entry point - PHP:
composer install - .NET:
dotnet run
Docker Support
All scaffolds come with a standard Dockerfile and docker-compose.yml. You can easily containerize your app by running:
docker-compose up --build
This will spin up both the application container and the selected database container automatically.