Skip to content

Turn your contracts into executable specifications. Contract Driven Development - Collaboratively Design & Independently Deploy MicroServices & MicroFrontends.

Notifications You must be signed in to change notification settings

znsio/specmatic-documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

76f5b3e · Feb 12, 2025
Nov 13, 2021
Aug 11, 2022
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
Feb 11, 2025
Feb 12, 2025
Feb 12, 2025
Jul 19, 2024
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
Jul 7, 2023
Feb 12, 2025
Dec 22, 2024
Aug 14, 2024
Feb 12, 2025
Nov 22, 2024
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
Aug 25, 2023
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
Dec 19, 2024
Aug 19, 2020
Dec 22, 2024
Jan 14, 2022
Nov 28, 2024
Feb 12, 2025
Oct 17, 2024
May 31, 2023
Aug 19, 2020
Feb 12, 2025
Aug 21, 2024
Aug 21, 2024
Feb 12, 2025
Oct 9, 2023
Feb 12, 2025
Feb 12, 2025
May 3, 2023
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
Feb 12, 2025
May 1, 2023
Nov 7, 2024
Feb 12, 2025
Nov 22, 2024
Jun 13, 2024
Jan 12, 2025
Oct 23, 2024
Jul 3, 2024
Mar 14, 2024
Nov 6, 2024
Nov 6, 2024
Aug 24, 2020
Mar 7, 2024
Feb 12, 2025
Mar 14, 2024
Apr 9, 2021
Apr 9, 2021
Apr 9, 2021
Mar 14, 2024
Mar 14, 2024
Aug 2, 2024
Oct 24, 2024
Jul 19, 2024
Jul 19, 2024
Mar 7, 2024
Apr 9, 2021
Apr 9, 2021
Apr 9, 2021
Oct 12, 2024
Feb 12, 2025
Sep 29, 2023
May 24, 2020
Dec 23, 2024
Nov 13, 2021
Nov 13, 2021
May 31, 2023

Repository files navigation

Specmatic Documentation

Documentation for Specmatic

Dev Setup

  • Install Ruby > 2.7 - Preferably with rbenv
  • Run bundle to install dependencies
  • Run bundle exec jekyll serve to start server on localhost:4000

Dev Containers (Recommended Approach)

  • Pre-requisites - Docker Desktop
  • Visual Studio Code 3
  • Open Project in VSCode
  • VSCode will ask you install necessary extensions and open in dev container. If not install "Visual Studio Code Remote - Containers" - https://code.visualstudio.com/docs/remote/containers
  • The Terminal inside VSCode is mapped to Docker Container. Run below commands in that terminal.
    • bundle to install dependencies
    • bundle exec jekyll serve to start server
      • Click on the "localhost:4000" link in terminal to launch it in browser at the ephemeral port
      • On my machine it is forwarded to localhost:4001
    • You can even push to GitHub inside this terminal because Dockerfile maps your keys

Reference - How to DevContainers for the first time for Jekyll Projects

  • Cmd + Shift + P and run Remote-Containers: Add Development Container Configuration Files...
  • Search for Jekyll and Choose bullseye
  • This will add the .devcontainers folder with necessary configs, re-open project in container

About

Turn your contracts into executable specifications. Contract Driven Development - Collaboratively Design & Independently Deploy MicroServices & MicroFrontends.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published