Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/aurora-cosmos/llms.txt

Use this file to discover all available pages before exploring further.

Aurora Cosmos is a fully-featured React portfolio template that wraps your work in a living cosmic environment. Every page sits inside animated aurora curtains, a multi-layer parallax starfield, and frosted-glass panels — all powered by Framer Motion, Tailwind CSS, and React Router.

Introduction

Learn what Aurora Cosmos is, what it includes, and when to use it.

Quickstart

Clone, install, and launch your celestial portfolio in under five minutes.

Project Structure

Understand how the codebase is organized before you start customizing.

Design System

Explore the cosmic color palette, Tailwind tokens, and utility classes.

​
What’s included

Aurora Cosmos ships seven pre-built portfolio pages, three animated background layers, a collapsible glassmorphism sidebar, and a fully responsive mobile menu — all wired together and ready to personalize.

AuroraBackground

Three-layer animated aurora gradient that drifts behind every page.

Starfield

175-star parallax field with twinkling animation and shooting stars.

Navigation

Collapsible sidebar on desktop, animated slide-down drawer on mobile.

​
Getting started

1

Clone the repository

git clone https://github.com/apursley2012/aurora-cosmos.git
cd aurora-cosmos
2

Install dependencies

npm install
Pre-built option: The repository is already a compiled static site. If you only want to preview or host it, you can skip npm install and npm run dev entirely — just serve the root directory with any static file server, for example npx serve ., and open the printed localhost URL.
3

Start the dev server

npm run dev
Open http://localhost:5173 to see the portfolio. Alternatively, if you are serving the pre-built output, run npx serve . from the project root instead.
4

Customize your content

Edit the page components in components/, update the styles in assets/main.css, and swap in your own projects, skills, and writing.

​
Customize the theme

Colors

Swap the aurora palette or add your own brand colors via Tailwind tokens.

Typography

Change Space Grotesk, Plus Jakarta Sans, or JetBrains Mono to your own fonts.

Animations

Tune Framer Motion durations, easing curves, and parallax scroll ratios.

Deployment

Deploy to GitHub Pages, Vercel, Netlify, or any static host with one command.

Build docs developers (and LLMs) love

Get started for freeTalk to us