A Remix Stack for US Federal web sites on AWS. Includes US Web Design System, react-uswds, pre-commit hooks for linting and type checking, and continuous integration with GitHub Actions
Overview:
Remix Americana Stack is a comprehensive web development framework that provides an accessibility-first design system and CSS framework specifically designed for United States government websites. It incorporates the U.S. Web Design System (USWDS) and offers a range of features for easy development and deployment of government web applications.
Features:
- Accessibility-first design system and CSS framework: Remix Americana Stack is built with an accessibility-first approach, ensuring that government websites are accessible to all users.
- USWDS widgets for React: The framework includes widgets and components that are compatible with React, making it easy to build interactive and dynamic user interfaces.
- AWS deployment with Architect: Remix Americana Stack provides seamless integration with Amazon Web Services (AWS) for easy deployment of government websites.
- Production-ready DynamoDB Database: The framework includes a production-ready DynamoDB database, offering a reliable and scalable storage solution for government applications.
- Code formatting with Prettier: Prettier is integrated into the framework, allowing for automatic code formatting and maintaining consistent code style across development teams.
- Linting with ESLint: ESLint is incorporated into Remix Americana Stack, enabling developers to enforce coding standards and catch potential issues early in the development process.
- Static Types with TypeScript: TypeScript is supported in the framework, providing static typing and improved code scalability and maintainability.
- Automated formatting, linting, and type checks: The framework includes tools like husky and lint-staged to automate formatting, linting, and type checks on git commits, ensuring code quality and consistency.
Installation:
To get started with Remix Americana Stack, follow the steps below:
- Install the AWS CLI by running the following command:
# command to install AWS CLI
- Set up the Architect framework by following the provided instructions:
# command to set up Architect
- Once the setup is complete, you can start running the development server by executing the following command:
# command to start the development server
Open your browser and navigate to http://localhost:3333 to access your local development environment.
To deploy your application, make sure you have completed the necessary AWS setup. Once done, you can build the app for production using the following command:
# command to build the app for production
- Deploy the application using the
arc command:
# command to deploy the application
- Your application is now ready to be accessed and used.
Summary:
Remix Americana Stack is a powerful web development framework designed specifically for United States government websites. It offers a comprehensive set of features, including an accessibility-first design system, USWDS widgets for React, AWS deployment with Architect, a production-ready DynamoDB database, code formatting with Prettier, linting with ESLint, static types with TypeScript, and automated formatting, linting, and type checks. By providing an all-in-one solution for government web development, Remix Americana Stack simplifies the process of building and deploying accessible and feature-rich web applications.