How to Deploy & Use dexteryy/spellbook-of-modern-webdev

# Deployment and Usage Guide

## Prerequisites

- **Git** (2.0+) for cloning the repository
- **Modern Web Browser** (Chrome, Firefox, Safari, Edge) to view the curated resources
- **GitHub Account** (required for contributing new links or corrections)
- **Node.js** (optional, only if running the web scraping scripts referenced for npm package statistics gathering)
- **Markdown Viewer** (optional, for offline reading: VS Code, Typora, or `npm install -g marked`)

## Installation

Clone the repository to your local machine:

```bash
git clone https://github.com/dexteryy/spellbook-of-modern-webdev.git
cd spellbook-of-modern-webdev

No dependency installation is required for basic usage as this is a curated documentation repository.

Configuration

This project requires no environment variables or API keys for consumption. However, contributors should understand the document taxonomy:

• Category Structure: Each line represents a unique category in a fine-grained classification
• Symbol Conventions:
  • / (forward slash with spaces): Indicates replaceable alternatives
  • , (comma with space): Indicates complementary tools/resources
• Selection Criteria: Links must reflect "not outdated and most commonly used" technologies, weighted by npm download counts over GitHub stars

For local development or fork maintenance, ensure your Git configuration supports UTF-8 for proper rendering of the 2000+ international resource links.

Build & Run

Viewing the Spellbook

Since this is a static Markdown knowledge base, no build step is required:

Option 1: GitHub Web Interface (Recommended) Navigate to https://github.com/dexteryy/spellbook-of-modern-webdev for the rendered Markdown experience with working hyperlinks.

Option 2: Local Server

# Using Python 3
python -m http.server 8000

# Using Node.js (npx)
npx serve .

# Using PHP
php -S localhost:8000

Then open http://localhost:8000/README.md in your browser.

Option 3: Markdown Preview Open README.md directly in VS Code, Typora, or similar Markdown-aware editors that support the Table of Contents navigation.

Data Collection (Optional)

If updating the npm statistics or running web scraping scripts mentioned in the methodology:

# If package.json exists in a subdirectory (check repository structure)
npm install
npm run scrape-stats  # Hypothetical - verify actual script names in repo

Deployment

Contributing to the Main Repository

1. Fork the repository on GitHub
2. Clone your fork:

   git clone https://github.com/YOUR_USERNAME/spellbook-of-modern-webdev.git
   

3. Create a branch for your additions:

   git checkout -b add-resource-category
   

4. Edit README.md following the established taxonomy:
   • Add missing links with rationale
   • Ensure links are not outdated
   • Verify npm download trends for JavaScript tools
5. Commit with clear messages explaining why the resource meets the "most commonly used" criteria
6. Push and Submit PR:

   git push origin add-resource-category
   

   Then open a Pull Request referencing the specific problem domain the link addresses.

Hosting Your Own Mirror

To deploy as a standalone site (e.g., for team internal use):

GitHub Pages Method:

1. Fork the repository
2. Go to Settings → Pages
3. Select "Deploy from a branch" → main branch → / (root)
4. Access at https://YOUR_USERNAME.github.io/spellbook-of-modern-webdev

Static Site Generator Method:

# Convert to Jekyll site
echo "theme: minimal" > _config.yml
bundle exec jekyll serve

# Or use Docsify for sidebar navigation
npx docsify init ./docs
npx docsify serve docs

Troubleshooting