Skip to content

🎭 A fully-featured coding reference website built in Go, delivering static assets via HTML and Bulma CSS.

License

Notifications You must be signed in to change notification settings

whalelogic/coderef

Repository files navigation

CodeRef - Programming Language Reference

A clean, interactive code reference website for multiple programming languages.

Features

  • πŸ“š Reference guides for Go, Python, and JavaScript
  • 🎨 Clean, responsive design using Bulma CSS
  • πŸ” Search functionality for filtering topics
  • πŸ“± Mobile-friendly interface
  • ⚑ Fast static file serving with Go

Clean and Extensible UI

image

Running the Server

Using Go (Recommended)

# Run directly
go run main.go

# Or build and run
go build -o coderef
./coderef

The server will start on http://localhost:8080 by default.

To use a different port:

PORT=3000 go run main.go

Using Python (Alternative)

python3 -m http.server 8000

Project Structure

.
β”œβ”€β”€ index.html              # Main entry point
β”œβ”€β”€ main.go                 # Go static file server
β”œβ”€β”€ go.mod                  # Go module file
β”œβ”€β”€ public/
β”‚   β”œβ”€β”€ about.html          # About page
β”‚   β”œβ”€β”€ contact.html        # Contact page
β”‚   β”œβ”€β”€ 404.html            # Custom 404 page
β”‚   β”œβ”€β”€ references/         # Language reference files
β”‚   β”‚   β”œβ”€β”€ go/
β”‚   β”‚   β”œβ”€β”€ python/
β”‚   β”‚   |── javascript/
|   |   β”œβ”€β”€ typescript/
|   |   β”œβ”€β”€ rust/
|   |   β”œβ”€β”€ ruby/
β”‚   └── static/
β”‚       β”œβ”€β”€ css/
β”‚       β”‚   └── style.css   # Custom styles
β”‚       └── js/
β”‚           └── app.js      # Dynamic content loading
└── README.md

Technologies

  • Frontend: HTML, CSS (Bulma), JavaScript
  • Backend: Go (static file server)
  • Fonts: Google Fonts (Roboto, Lato)
  • Syntax Highlighting: Prism.js
  • Icons: Devicon, Font Awesome and Icons8
  • Search: Simple JavaScript filtering
  • Deployment: Static hosting compatible

Branding

The CodeRef logo is an referee icon, representing rules and regulations, which when followed, provide a critical foundation for learning programming and attainment of qualitive knowledge. The icon is sourced from Icons8.

License

MIT License

About

🎭 A fully-featured coding reference website built in Go, delivering static assets via HTML and Bulma CSS.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published