Skip to main content

Documentation Index

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

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

This page walks through everything you need to get Player One running on your local machine — from confirming the right version of Node.js is installed to cloning the repository and verifying the pre-built asset bundle is in place. Follow the steps below and you will have a working local copy in just a few minutes.

​
Prerequisites

Before you begin, make sure the following tools are installed on your system:
  • Node.js 18+ (LTS release recommended — download from nodejs.org)
  • npm 9+ (bundled with Node.js 18 LTS) or a compatible package manager such as Yarn or pnpm
  • Git (any recent version)
You can verify your installed versions with: 
node --version   # should print v18.x.x or higher
npm --version    # should print 9.x.x or higher
git --version

​
Setup Steps

1
Clone the repository
2
Clone the Player One repository from GitHub and change into the project directory:
3
git clone https://github.com/apursley2012/player-one.git && cd player-one
4
Install dependencies
5
Install the project’s Node.js dependencies using your preferred package manager:
6
npm
npm install
yarn
yarn install
pnpm
pnpm install
7
Verify the installation
8
Confirm that the pre-built asset bundle is present by listing the assets/ directory:
9
ls assets/
10
You should see output similar to the following:
11
createLucideIcon.js
jsx-runtime.js
main.css
main.js
proxy.js
Player One ships with a pre-built asset bundle — assets/main.js and assets/main.css are already compiled and ready to serve. For a basic local preview you only need a static file server; you do not need to run a full Vite dev build. The CSS bundle imports the Press Start 2P and VT323 retro fonts directly from Google Fonts, so an internet connection is required for the full visual experience.

​
Environment Configuration

Player One is an entirely static portfolio site — there is no backend, no database, and no external API integrations. As a result:
  • No .env file is required.
  • No API keys or secrets need to be configured.
  • All data (projects, skills, writing samples) is hard-coded inside the React components.
You can clone the repository and serve it immediately without any additional configuration steps.

​
Editor Recommendations

If you plan to customise Tailwind CSS utility classes inside the components, install the Tailwind CSS IntelliSense extension for Visual Studio Code. It provides autocomplete, syntax highlighting, and inline documentation for every Tailwind class used throughout the project, which makes working with the arcade-themed colour palette and responsive layout utilities significantly faster.

Build docs developers (and LLMs) love

Get started for freeTalk to us