installation.md

Installation Guide

Welcome to MetaSSR! This guide will walk you through the installation process so you can start building with the framework in no time.

Table of Contents

• Installation Guide
  • Table of Contents
  • Manual Installation Steps from Source
    • Prerequisites
    • 1. Clone Git Repository
    • 2. Compiling
    • 3. Add the CLI Binary to PATH (Linux)
    • 4. Create Your First Project
  • Conclusion

Manual Installation Steps from Source

Prerequisites

Before installing MetaSSR, ensure you have the following installed on your machine:

• Git: v2.25.0 or higher (optional but recommended)
• Metacall: v0.8.1 or higher
• Rust: v1.76 (optional but recommended)

You can verify the installation of these tools using the following commands:

rustc -v
git --version

1. Clone Git Repository

At first, you need to clone this repository:

$ git clone https://github.com/metacall/metassr.git metassr
$ cd metassr

2. Compiling

After cloning the repo and getting inside it, compile it via cargo, the package manager of Rust programming languages:

$ cargo build --release

3. Add the CLI Binary to PATH (Linux)

Now, you'll want to make the binary of metassr globally accessible. To do this on Linux, add the binary to your PATH:

sudo ln -s $(pwd)/target/release/metassr /usr/local/bin/metassr

4. Create Your First Project

After completing the above steps, you'll be able to create your first web application with MetaSSR!

$ metassr create <project-name>

Conclusion

You have successfully installed and set up your first SSR framework project! Explore the docs for more advanced features and customization options.

If you encounter any issues during installation, please reach out to our community on GitHub and open a new issue!

Happy coding!