easySH Project Generator

The project is a web-based tool for generating custom projects. It consists of a frontend built with React and Vite, and a backend powered by FastAPI and Docker.

Quick Start

Running the Application

1. Start the Backend:

   cd backend
   python -m uvicorn main:app --reload --host 127.0.0.1 --port 8000

2. Start the Frontend:

   cd frontend
   npm install
   npm run dev

3. Access the Application:

   • Frontend: http://localhost:5173
   • Backend API: http://localhost:8000

What's New in Version 1.2.1

🔧 CORS Fix: Resolved GitHub Pages ↔ Railway communication issues
✅ Production Ready: Frontend and backend now communicate seamlessly in production
🧪 Testing Tools: Added development mode CORS connectivity testing

What's New in Version 1.2.0

✅ Enhanced Configuration: Frontend now collects all backend-required fields ✅ Extended Wizard: Added database configuration step for complete setup
✅ API Synchronization: Fixed frontend-backend configuration mismatch
✅ Better UX: Improved form validation and detailed configuration review

Features

• Guided Project Setup: Step-by-step wizard with gamification
• Full Stack Projects: Complete FastAPI backend + React frontend
• Production Ready: Docker configurations and deployment scripts
• One-Click Download: Get a complete, ready-to-run project in seconds
• Best Practices: Latest libraries and FiBank coding standards

Generated Project Structure

project-name/
├── project-name-backend/     # FastAPI backend with PostgreSQL
├── project-name-frontend/    # React + Vite frontend with Tailwind
└── setup_environment.sh     # One-command setup script

Documentation

📖 Complete Documentation - Comprehensive guides and architecture documentation

Quick Links

• Project Overview - What easySH is and why it exists
• Development Guide - Complete setup and development workflow
• System Architecture - How the system works
• Changelog - Recent updates and improvements

Project Structure

• backend/: Contains the FastAPI backend application.
  • main.py: The main application file.
  • requirements.txt: Python dependencies.
  • templates/: Jinja2 templates for generating project files.
• frontend/: Contains the React frontend application.
  • src/: The main source code for the React application.
  • package.json: Frontend dependencies and scripts.
• scripts/: Contains the original shell scripts that were used as a reference.
• docs/: Contains organized project documentation (see Documentation).

How to Run

Backend

The backend is designed to be run with Docker.

1. Build and run the Docker containers:

   docker-compose up --build

2. The backend will be available at http://localhost:8000.

Frontend

1. Navigate to the frontend directory:

   cd frontend

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. The frontend will be available at http://localhost:5173.

Use this web interface to configure and generate custom projects.

Contributing

This project is designed for FiBank Bulgaria's internal use. See the Development Guide for detailed information about working with the codebase.

Version History

• v1.2.0: Enhanced configuration synchronization and extended wizard
• v1.1.0: Complete gamification system and UI improvements
• v1.0.0: Initial release with core functionality

See Changelog for detailed version history.

Deployment

Backend (Port Forwarding)

./start_backend.sh

Then forward port 8000 in VS Code (Ports tab → Public).

Frontend (GitHub Pages)

Set GitHub repository secret VITE_API_BASE_URL_PROD with your port forwarding URL. Deploy happens automatically on push to main.

See GitHub Secrets Setup for details.