Getting started with Astroship

Astroship is designed to get you up and running quickly so you can onboard your first customers. Building on best practices and patterns, Astroship serves as a foundation for your project to grow.

This documentation will guide you through:

• Setting up your project for development
• Configuring, extending, and customizing Astroship for your project
• Deploying your project

Quick Start

1. Create a new project

# Clone the repository
git clone git@github.com:astroship-ai/kit.git <project-name>
cd <project-name>

# Rename repository origin for future Astroship updates
git remote rename origin astroship

# Create a new empty repository on GitHub and add it as the origin
git remote add origin <your-repository-url>
git push -u origin main

Set up GitHub

To clone the repository you must configure your computer to access the GitHub account you signed up with. If you haven’t configured GitHub, you can follow the GitHub Setup Guide ↗.

2. Install packages

npm install --include=dev

Install Node.js

We recommend using nodenv to manage node.js versions instead of installing node globally.

# Install homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install nodenv
brew install nodenv

# Install node.js (must be in the root directory of your project)
nodenv install -s

3. Start the development server

npm run dev

The development server should now be accessible at: http://localhost:4321 ↗

Congratulations! You have successfully set up your project with Astroship. 🚀