Skip to content

Latest commit

 

History

History

getting-started

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Welcome to the MetaSSR Getting Started guide! This folder provides essential information to help you quickly set up and begin working with the MetaSSR framework.

Table of Contents

Overview

MetaSSR is a powerful framework for building Server-Side Rendered (SSR) web applications that is built on Metacall. It was developed as a real-world use-case for Metacall and polyglot programming. This guide will walk you through the installation process and provide an overview of the command-line interface (CLI) to help you get started.

Installation Guide

To get MetaSSR up and running on your system, follow the detailed installation instructions provided in the installation.md file. This guide covers:

  • Prerequisites and system requirements
  • How to install MetaSSR from pre-built binaries
  • Building and installing MetaSSR from source

You can find the installation guide here.

Folder Structure

Understanding the folder structure of a MetaSSR project is crucial for effective development. The folder-structure.md file provides a detailed overview of the default directory setup and the purpose of each folder. This section covers:

  • The root directory and its contents
  • Important directories such as src, static, and dist

You can explore the folder structure guide here.

Command-Line Interface (CLI) Documentation

The MetaSSR CLI is an essential tool for managing your MetaSSR projects. It allows you to perform various tasks such as building, running, and creating projects. The cli.md file provides comprehensive documentation on how to use the CLI, including:

  • Global options available with any command
  • Detailed descriptions of each command (build, run, create)
  • Examples of common use cases

You can access the CLI documentation here.

Getting Help

If you encounter any issues or have questions, feel free to reach out to the MetaSSR community or consult the additional resources provided in the project repository.

Happy coding with MetaSSR!