Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.17 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.17 KB
Raw

SSZ SimpleSerialize

SSZ Website in progress...

Deployed site with Overview: www.ssz.dev

"Main" branch contains Visualizer in development

To Contribute:

  • Please branch off of "Main"
  • Overview pages exist as markdown files in "overview" directory. Improvements to these are welcome.
  • Visualization lives in "Simulator" directory. Design improvements are desired.

To install this project locally:

  • If you don’t have Node.js installed, install it from here. You’ll need Node.js version 10.13 or later.

  • Create a Next.js app

    • To create a Next.js app, open your terminal, cd into the directory you’d like to create the app in, and run the following command:
npx create-next-app ssz-simpleserialize --use-npm --example "https://github.com/ScottyPoi/SSZ-SimpleSerialize/tree/main"

Inside that directory, you can run several commands:

  • npm run dev

    • Starts the development server.

  • npm run build

    • Builds the app for production.

  • npm start

    • Runs the built app in production mode.

We suggest that you begin by typing:

  cd ssz-simpleserialize

  npm run dev