Mathlet

Mathlet is a project by Christian and Philip. This project is built using Astro.

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed Node.js (version 18 or higher).
• You have installed pnpm (version 7.1.0 or higher).

Setup

1. Clone the repository:

   git clone https://github.com/yourusername/mathlet.git
   cd mathlet

2. Install dependencies:

   pnpm install

Usage

Development

To start the development server, run:

pnpm run dev

Build

To build the project, run:

pnpm run build

Preview

To preview the build, run:

pnpm run preview

Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
├── src/
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Configuration

• astro.config.mjs: Configuration file for the Astro project.
• tsconfig.json: TypeScript configuration file.
• .vscode/launch.json: Configuration for running the development server in Visual Studio Code.

Deployment

The project is set up to deploy to GitHub Pages using a GitHub Actions workflow. The configuration can be found in .github/workflows/deploy.yml.