Skip to content
This repository has been archived by the owner on Apr 19, 2024. It is now read-only.

ongov/Ontario.ca-Jamstack-Toolkit

Repository files navigation


Official Deprecation Announcement

As of 2024-04-19, the Ontario.ca Jamstack Toolkit project is officially deprecated. This repository will no longer receive updates or support. Our team is excited to introduce a more advanced and robust version, Ontario.ca Frontend, which we encourage all users to adopt.

Rationale for Deprecation

  • New Features and Improvements: The new version of our toolkit includes significant enhancements and additional features that are not supported in this version.

  • Better Performance and Stability: The updated toolkit offers improved performance and stability, aligning with our ongoing commitment to providing high-quality and robust digital solutions.

Recommended Actions

  • Migrate to Ontario Frontend: To benefit from the latest improvements and continued support, we strongly recommend migrating to the new toolkit available at Ontario Frontend.

  • Repository Archive: This project will be preserved in a read-only state for archival purposes, allowing users to access and reference the legacy codebase as needed.

We appreciate your support and understanding as we continue to improve our digital offerings.


Ontario.ca Jamstack Toolkit

The best way to start building applications for Ontario.ca.

This Ontario.ca Jamstack Toolkit is designed for teams that want to create maintainable, performant and dynamic user experiences for the public that integrate with Ontario.ca. Quickly start building a frontend application using the Ontario Design System and enrich it with backend APIs.

Get started using the toolkit

You can get a new Ontario.ca Jamstack application running in your local dev environment with these steps:

  1. Clone this repository.

    git clone https://github.com/ongov/Ontario.ca-Jamstack-Toolkit
  2. Configure your application details.

    Move into the newly cloned directory, install the needed packages, and enter the new project setup command:

    cd jamstack-application-toolkit
    npm install
    node jam-on.mjs new
  3. Start the application in develop mode.

    npm run serve
  4. Open the source code and start editing.

    Your application is now running at http://localhost:8080. Open the jamstack-application-toolkit directory in your code editor of choice to start making changes.

You now have a functioning Ontario.ca Jamstack application running locally.

Learning to use the toolkit

Find documentation and guides for working with the toolkit in the GitHub Wiki.

Contributions

We welcome suggestions for improving the toolkit. See CONTRIBUTING.md for our guide on contributing to this project.

License

Licensed under Apache License 2.0.