Skip to content

habedi/template-racket-project

Racket Project Template

Racket Logo

Tests Code Coverage CodeFactor Docs License Release

This is a template for Racket projects.
It provides a minimalistic project structure with pre-configured GitHub Actions, a Makefile,
and configuration files for development tools.
The template is intended as a starting point to make it easier to begin development of new Racket libraries
and applications.
I’m sharing it here in case it’s useful to others.

Features

  • Minimalistic project structure
  • Pre-configured GitHub Actions for running tests and tracking code coverage
  • Makefile for managing the development workflow and tasks like code formatting, testing, generating documentation, etc.
  • GitHub badges for tests, code quality and coverage, documentation, etc.
  • Code of Conduct and Contributing Guidelines

Getting Started

Check out the Makefile for available commands to manage the development workflow.

# Install system and development dependencies (for Debian-based systems)
sudo apt-get install make
make install-deps
# See all available commands and their descriptions
make help

Platform Compatibility

This template is primarily intended for Debian-based GNU/Linux systems. However, with some adjustments,
it should work on other platforms too.

Contributing

See CONTRIBUTING.md for details on how to make a contribution.

License

This project is licensed under the MIT License (LICENSE or https://opensource.org/licenses/MIT)