Quick Start Guide¶

Get up and running with Shadow Scroll Blossom in minutes.

Prerequisites¶

• Node.js 16+ (recommend using nvm)
• npm or Yarn
• Git

Local Development¶

1. Clone the Repository¶

git clone https://github.com/BA-CalderonMorales/shadow-scroll-blossom.git
cd shadow-scroll-blossom

2. Install Dependencies¶

npm install

Or using Yarn:

yarn install

3. Start the Development Server¶

npm run dev

Or using Yarn:

yarn dev

Open http://localhost:8080 in your browser.

4. Build for Production¶

npm run build

Or using Yarn:

yarn build

The production build will be in the dist/ directory.

5. Preview Production Build¶

npm run preview

Or using Yarn:

yarn preview

Project Scripts¶

• dev: Start development server
• build: Create production build
• preview: Preview production build locally
• lint: Run ESLint
• format: Format code with Prettier

Deployment¶

The project is automatically deployed to GitHub Pages on every push to the main branch. Pull requests generate preview deployments for review.

Manual Deployment¶

1. Build the project: bash npm run build

2. Deploy to GitHub Pages: bash git add dist -f git commit -m "Deploy to GitHub Pages" git subtree push --prefix dist origin gh-pages

Next Steps¶

• Explore the Details for advanced configuration
• Learn how to create custom themes
• Check out the keyboard shortcuts