mirror of https://github.com/Shineii86/MiruroAPI.git synced 2026-10-22 18:25:11 +00:00

Files

T

Sʜɪɴᴇɪ Nᴏᴜᴢᴇɴ 1433afdca1 v1.3.0: Full landing page upgrade + feature parity with AniKotoAPI

- Full index.html rewrite with AniKotoAPI-style features:
  * Canvas particle effects (cyan particles)
  * Scroll-reveal animations (IntersectionObserver)
  * Animated stat counters (count up on scroll)
  * Infinite scrolling marquee (8 feature badges)
  * Live interactive API console (5 presets: Search, Trending, Episodes, Info, Health)
  * Sidebar endpoint explorer (16 endpoints, multi-language tabs: cURL/JS/Python)
  * 4 interactive playground cards (Search, Info, Episodes, Trending)
  * Custom scrollbar, JetBrains Mono font
  * 4-column grid footer with API/Resources/Legal
  * Fixed header with scroll-aware glass blur
  * Ambient orb gradient animations
  * CTA section with gradient overlay
- Added public/404.html (glitch animation error page)
- Added public/manifest.json (PWA, theme: #38bdf8)
- Added public/robots.txt (Allow /, Disallow /api)
- Added public/sitemap.xml (4 URLs)
- Added public/tos.html (13 sections)
- Added public/privacy.html (8 sections)
- Added .env.example, CONTRIBUTING.md, LICENSE, render.yaml, test.js
- Added docs/ (5 files: index, endpoints, streaming, examples, architecture)
- Updated server.js: clean URL routes (/tos, /privacy), 404.html fallback
- Updated package.json: devDependencies nodemon, repository, dev script
- All branding: AniKotoAPI → MiruroAPI, cyan color scheme (#38bdf8)

2026-06-09 16:21:30 +05:30

2.0 KiB

Raw Permalink Blame History

Contributing to MiruroAPI

Thank you for your interest in contributing! Here's how you can help.

Getting Started

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/MiruroAPI.git
Create a branch: git checkout -b feature/amazing-feature
Make your changes
Commit: git commit -m 'feat: add amazing feature'
Push: git push origin feature/amazing-feature
Open a Pull Request

Development Setup

# Install dependencies
npm install

# Start development server
npm run dev

# Server runs on http://localhost:3000

Project Structure

MiruroAPI/
├── server.js              # Express entry point
├── src/
│   ├── helpers/           # AniList, pipe, cache integrations
│   └── routes/            # Express routes
├── public/                # Static files (landing page, Swagger UI)
└── docs/                  # API documentation

Adding a New Endpoint

Create helper in src/helpers/yourHelper.js if needed
Add route in src/routes/apiRoutes.js
Update docs/endpoints.md with documentation
Test with curl http://localhost:3000/api/your-endpoint

Code Style

Use CommonJS (require/module.exports)
Add JSDoc comments for new functions
Follow existing patterns in the codebase
Keep helpers focused on one task

Commit Messages

Use Conventional Commits:

feat: new feature
fix: bug fix
docs: documentation changes
refactor: code refactoring
test: adding tests
chore: maintenance

Pull Request Guidelines

Keep PRs focused on one feature or fix
Update CHANGELOG.md with your changes
Test your changes locally before submitting
Follow existing code style

Reporting Issues

Use GitHub Issues for bug reports
Include steps to reproduce
Include expected vs actual behavior
Include your Node.js version

License

By contributing, you agree that your contributions will be licensed under the MIT License.

2.0 KiB Raw Permalink Blame History