Skeleton Application

A skeleton application with a Rust backend, PostgreSQL database, and React frontend. Clone and change it to your needs to kickstart your next project!

Quick Start

Prerequisites

• Docker and Docker Compose

Running the Application

1. Clone the repository:

   git clone <repository-url>
   cd skeleton-application

2. Start everything:

   docker-compose up --build

3. Access the application:

   • Frontend: http://localhost:3000
   • Backend API: http://localhost:3001
   • Database: localhost:5432

That's it! The setup automatically:

• Creates the backend .env file from .env.example
• Runs database migrations
• Starts all services with hot reloading enabled
• Mounts source code for live development

Development

Making Changes

• Backend: Edit files in backend - changes will trigger automatic reload
• Frontend: Edit files in frontend/src/ - Vite will hot reload the browser

Useful Commands

# Stop all services
docker-compose down

# Restart services
docker-compose up

# View logs
docker-compose logs -f

# Access database
docker-compose exec postgres psql -U postgres -d postgres

# Clean up everything (including volumes)
docker-compose down -v

Services

• Backend: Rust application on port 3001 (hot reload enabled)
• Frontend: React application (Vite) on port 3000 (hot reload enabled)
• Database: PostgreSQL 18 on port 5432

Project Structure

skeleton-application/
├── backend/           # Rust backend application
├── backend/docker-compose.yml # Backend-specific  Docker setup
├── frontend/          # React frontend application
├── frontend/docker-compose.yml # Frontend-specific Docker setup
├── docker-compose.yml # Fullstack development Docker setup
└── README.md          # This file

LICENSE

Unlicensed under The Unlicense. See LICENSE file for details.

Contributing

Feel free to open issues or submit pull requests! Contributions are welcome!

Roadmap

Following features are planned for development:

• Add authentication
• CI/CD setup with GitHub Actions
• Unit and integration tests
• Docker production setup
• API documentation with Swagger