Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (45 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 1.7 KB

Contributing to Forkcast

If you see incorrect information about an EIP's impacts or benefits, content-only pull requests are very welcome. Structural changes or feature requests should open an issue first.

Development Setup

With Docker:

make docker-dev

Without Docker:

make install
make dev

Open http://localhost:5173 in your browser.

Run make help for all available commands.

Deployment

The site automatically deploys to GitHub Pages when changes are merged into the main branch.

Project Structure

forkcast-public/
├── src/
│   ├── components/
│   │   └── HomePage.tsx         # Landing page with upgrade list
│   ├── data/
│   │   └── eips.json            # EIP data
│   ├── App.tsx                  # Main app component with routing
│   ├── main.tsx                 # App entry point
│   ├── index.css                # Global styles
│   └── vite-env.d.ts            # Vite type definitions
├── public/                      # Static assets
├── package.json
├── vite.config.ts               # Vite configuration
└── tsconfig.json                # TypeScript configuration

Technology Stack

  • React - UI framework
  • TypeScript - Type safety
  • Vite - Build tool and dev server
  • React Router - Client-side routing
  • Tailwind CSS - Styling
  • ESLint - Code linting

Data Structure

The application uses a JSON file (src/data/eips.json) containing EIP information. Each EIP includes:

  • Basic metadata (ID, title, status, author, etc.)
  • Fork relationships (which network upgrades include this EIP)
  • Public-facing explanations and impact assessments