Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 1.88 KB

README.md

File metadata and controls

83 lines (53 loc) · 1.88 KB
Raw

getabc.sh

This repo contains the website for https://getabc.sh/

For the actual abc software, see https://github.com/alestic/abc

Development Workflow

The project uses a Makefile to standardize development workflows. The build system requires npm and node to be installed on your system.

Project Structure

This website is a Next.js project using:

  • TypeScript for type safety
  • ESLint for code quality
  • TailwindCSS for styling
  • GitHub Pages for deployment

To see all the files in the project, read:

  • doc/tree.txt

Setup / Cleanup

Setup/reset the development environment:

make setup

Clean all artifacts and dependencies:

make clean

Development

Start the development server with hot-reload for real-time changes:

make serve-dev

This will run the site at http://localhost:3000 with live updates as you modify the code, making it ideal for active development.

Before committing changes, run the checks:

make checks

This will run the linter and type checker to ensure code quality.

Production Testing

To test how the site will behave in the actual production environment:

# Build static files (generates production-optimized static assets)
make build-static

# Start production server to preview the static build
make serve-static

This will serve the production-equivalent build at http://localhost:3001, allowing you to verify how the site will actually appear and function when deployed.

Deployment

Deployment to GitHub Pages is automated using GitHub Actions. Simply push your changes to the main branch:

git add [files]...
git commit -m "Your commit message"
git push

The GitHub Actions workflow will automatically build and deploy the site to GitHub Pages.

Credits

This website was designed and created by: OpenAI o1, v0.net, Cline 2 with Claude 3.5 Sonnet Prompt crafting by: Eric Hammond