🚀 StaticJS

A modern React boilerplate for creating static projects

Start your static projects in seconds with an optimized architecture

Installation • Usage • Features • Examples

📖 Table of Contents

• 🎯 About
• ✨ Features
• 🚀 Installation
• 📘 Usage
• 🔄 Revalidation
• ⚙️ Configuration
• 📚 Examples
• 📄 License

🎯 About

StaticJS is a powerful and modern boilerplate designed for creating static projects. It integrates development best practices and offers advanced features like specific page revalidation.

Why StaticJS?

• ⚡ Ultra-fast startup - Initialize your project in seconds
• 🔄 Smart revalidation - Rebuild specific pages on demand
• 🏗️ Modern architecture - Optimized and maintainable project structure
• 🚀 Production ready - Production-ready configuration
• 📱 Responsive - Native support for all devices

✨ Features

Feature	Description
🚀 Fast generation	Project creation with a single command
🔄 WebSocket Hot Reloading	Real-time WebSocket-based development reloading
📦 Optimized build	Production-optimized bundle
🎯 Targeted revalidation	Specific page reconstruction via API
🛠️ Flexible configuration	Advanced customization according to your needs
📊 Performance	Automatic performance optimizations

🚀 Installation

Prerequisites

• Node.js >= 16.0.0
• npm >= 7.0.0

Global installation

npm i @bouygues-telecom/staticjs -g

💡 Tip: Global installation allows you to use the create-staticjs-app command from anywhere on your system.

📘 Usage

1. Create a new project

create-staticjs-app

This command will:

• 📁 Create the folder structure
• ⚙️ Configure base files
• 📦 Prepare the development environment

2. Install dependencies

cd your-project
npm i

3. Build & Start the server

npm run start

🎉 Your project is now accessible at http://localhost:3300

🔄 Revalidation

StaticJS offers a unique targeted revalidation feature that allows rebuilding specific pages without rebuilding the entire project.

Basic syntax

curl -X POST http://localhost:3000/revalidate \
  -H "Content-Type: application/json" \
  -d '{ "paths": ["page.tsx"] }'

📚 Examples

Revalidate a single page

curl -X POST http://localhost:3000/revalidate \
  -H "Content-Type: application/json" \
  -d '{ "paths": ["home.tsx"] }'

Revalidate multiple pages

curl -X POST http://localhost:3000/revalidate \
  -H "Content-Type: application/json" \
  -d '{ "paths": ["home.tsx", "about.tsx", "contact.tsx"] }'

⚙️ Configuration

Project structure

your-project/
├── 📁 src/
│   ├── 📁 pages/          # Your pages
│   ├── 📁 components/     # Reusable components
│   ├── 📁 styles/         # Style files
│   └── 📁 utils/          # Utilities
├── 📁 public/             # Static assets
├── 📄 package.json
└── 📄 server.js           # StaticJS server

🛠️ Available scripts

Script	Description
npm run build	Build the project for production
npm run start	Start the production server

📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.

---

Developed with ❤️ by the Bouygues Telecom team