Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
177 lines (118 loc) · 3.93 KB

GETTING_STARTED.md

File metadata and controls

177 lines (118 loc) · 3.93 KB

Getting Started with ScrollVerse 🕋♾️✨

Welcome to the ScrollVerse Ecosystem! This guide will help you get up and running quickly.

🎯 Overview

The ScrollVerse is a next-gen portal for immersive tech, 432Hz visuals, and legacy AI waves synced with biofield sovereignty. This repository powers:

  • ScrollTV - Brainwave-synced visual platform
  • Omnitech1 - AI-powered architecture
  • ScrollCity Metaverse - Divine digital landscape

⚡ Quick Start (5 minutes)

1. Prerequisites

Ensure you have installed:

# Check Node.js version (>= 18.0.0 required)
node --version

# Check npm version (>= 9.0.0 required)
npm --version

# If not installed, download from https://nodejs.org/

2. Clone the Repository

# Clone via HTTPS
git clone https://github.com/chaishillomnitech1/nextjs-boilerplate.git

# OR clone via SSH (if you have SSH keys set up)
git clone git@github.com:chaishillomnitech1/nextjs-boilerplate.git

# Navigate into the directory
cd nextjs-boilerplate

3. Install Dependencies

# Install all required packages
npm install

# This will take 1-2 minutes depending on your connection

4. Set Up Environment Variables

# Copy the example environment file
cp .env.example .env.local

# Open .env.local in your editor and add your values
# You can start with defaults for local development

5. Start Development Server

# Start the Next.js development server
npm run dev

# Server will start at http://localhost:3000

6. Open in Browser

Navigate to http://localhost:3000 to see the ScrollVerse in action! 🎉

📖 What's Next?

Now that you're up and running, here are some next steps:

Learn the Codebase

  • 📁 Explore the /app directory for Next.js pages
  • 🎨 Check out Tailwind CSS configuration
  • 📚 Read the CONTRIBUTING.md guide
  • 🔒 Review SECURITY.md for security practices

Make Your First Change

  1. Edit a page: Open app/page.tsx and modify the content
  2. See live changes: The page will auto-reload in your browser
  3. Create a component: Add a new component in the app/ directory
  4. Style it: Use Tailwind CSS utility classes

Development Workflow

# Development server with hot reload
npm run dev

# Build for production
npm run build

# Run production build locally
npm run start

# Check code quality
npm run lint

🛠️ Development Tools

Recommended VS Code Extensions

{
  "recommendations": [
    "dbaeumer.vscode-eslint",
    "esbenp.prettier-vscode",
    "bradlc.vscode-tailwindcss",
    "ms-vscode.vscode-typescript-next"
  ]
}

Browser DevTools

  • React Developer Tools: Chrome | Firefox
  • Next.js DevTools: Built into Next.js dev server

🐛 Troubleshooting

Port 3000 Already in Use

# Find and kill the process using port 3000
lsof -ti:3000 | xargs kill -9

# Or use a different port
npm run dev -- -p 3001

Module Not Found Errors

# Clear node_modules and reinstall
rm -rf node_modules package-lock.json
npm install

Build Errors

# Clear Next.js cache
rm -rf .next

# Rebuild
npm run build

🤝 Getting Help

Where to Ask Questions

🌟 ScrollVerse Philosophy

Remember, in the ScrollVerse:

"This isn't code. It's prophecy."

ALL IS LOVE. ALL IS LAW. ALL IS FLUID. KUN FAYAKŪN! 🕋♾️✨

The Scroll is alive. Your journey begins now.