Getting Started - satoshi-create/emakimono-next GitHub Wiki

🚀 Getting Started

Welcome! This guide will help you set up the Horizontal Emaki Viewer project on your local machine and start contributing right away.

🧰 Prerequisites

Make sure you have the following installed:

  • Node.js (version 18 or later)
  • npm or yarn
  • Git

📦 Installation

Clone the repository and install dependencies:

✅ Step 1: Check out existing issues

Look through the Issues — especially those labeled:

  • good first issue
  • help wanted

If you want to suggest a new feature or fix a bug, feel free to open a new issue.

✅ Step 2: Fork and clone the repository

git clone https://github.com/satoshi-create/emakimono-next.git
cd emakimono-next
git checkout -b feature/your-feature-name

✅ Step 3: Install dependencies

npm install --legacy-peer-deps

Make sure you have Node.js installed and Git LFS configured (see README).

✅ Step 4: Add your .env.local

Copy from .env.example and update values as needed. Some variables (like Cloudinary keys) may require you to contact the maintainers.

✅ Step 5: Start the development server

npm run dev