Everything you need tobuild in public
Comprehensive guides, API documentation, and examples to help you get started and make the most of the Build in Public platform.
Quick Start
Get up and running in minutes
API Reference
Complete API documentation
Examples
Real-world implementation guides
Browse bycategory
Find exactly what you're looking for with our organized documentation sections.
Quickstart guide
Get up and running with Build in Public in just a few minutes. Follow these simple steps to start your journey.
git clone https://github.com/deepakkumar55/Build-in-public.git
cd Build-in-public
npm installcp .env.example .env.local
# Edit .env.local with your configuration
npm run setupnpm run dev
# Open http://localhost:3000Ready for more?
Explore our comprehensive API documentation and advanced configuration options.
APIReference
Complete documentation for all API endpoints, authentication methods, and response formats to integrate with Build in Public.
/api/projectsRetrieve all projects
Parameters:
Response:
{
"projects": [
{
"id": "proj_123",
"name": "My Awesome Project",
"status": "active",
"created_at": "2024-01-01T00:00:00Z"
}
],
"total": 1
}/api/projectsCreate a new project
Parameters:
Response:
{
"id": "proj_124",
"name": "New Project",
"status": "active",
"created_at": "2024-01-01T00:00:00Z"
}/api/updatesGet project updates
Parameters:
Response:
{
"updates": [
{
"id": "update_123",
"content": "Today I worked on...",
"project_id": "proj_123",
"created_at": "2024-01-01T00:00:00Z"
}
]
}/api/auth/loginAuthenticate user
Parameters:
Response:
{
"token": "eyJhbGciOiJIUzI1NiIs...",
"user": {
"id": "user_123",
"email": "user@example.com"
}
}Authentication
All API requests require authentication using Bearer tokens. Include your token in the Authorization header.
Authorization: Bearer your-api-token-hereCodeExamples
Ready-to-use examples and starter templates to help you integrate Build in Public into your projects quickly.
import { BuildInPublic } from '@build-in-public/react'
function App() {
return (
<div>
<BuildInPublic
projectId="your-project-id"
apiKey="your-api-key"
theme="light"
>
<ProjectDashboard />
<UpdatesFeed />
<ProgressTracker />
</BuildInPublic>
</div>
)
}React Integration
Complete React app with Build in Public integration
What's included:
- Complete source code
- Setup instructions
- Environment configuration
- Deployment guide
- Best practices
Join ourcommunity
Get help, share knowledge, and contribute to making Build in Public better for everyone.
GitHub Discussions
Ask questions, share ideas, and connect with other developers
Discord Server
Real-time chat with the community and development team
Contributing Guide
Learn how to contribute to the project and make an impact
Support Forum
Get help with technical issues and implementation questions
How you can contribute
There are many ways to contribute to Build in Public, regardless of your experience level.
Documentation
Improve guides, fix typos, add examples
BeginnerBug Reports
Report issues and help us fix them
BeginnerFeature Requests
Suggest new features and improvements
IntermediateCode Contributions
Submit pull requests for new features
AdvancedStill need help?
Can't find what you're looking for? Our community and support team are here to help.