Skip to content

QuasarAPI/quasarflow-website

Repository files navigation

QuasarFlow Website

Modern landing page and documentation for QuasarFlow API - Blockchain abstraction API that simplifies Stellar network integration

About

This is the official website for QuasarFlow API, featuring:

  • Modern Landing Page - Hero section, features showcase, and call-to-action
  • Comprehensive Documentation - Getting started guide, API reference, and examples
  • Interactive Examples - Code samples in multiple languages (JavaScript, Python, Go)
  • Responsive Design - Mobile-first design with dark mode support
  • SEO Optimized - Meta tags, structured data, and performance optimized

Features

  • 🚀 Next.js 15 with App Router
  • 🎨 Tailwind CSS for styling
  • 📱 Responsive Design with mobile-first approach
  • 🌙 Dark Mode support
  • 📚 Documentation with interactive examples
  • 🔗 API Reference with detailed endpoints
  • 💻 Code Examples in multiple programming languages

Getting Started

Prerequisites

  • Node.js 18+
  • npm, yarn, or pnpm

Installation

  1. Clone the repository:
git clone https://github.com/QuasarAPI/quasarflow-website.git
cd quasarflow-website
  1. Install dependencies:
npm install
# or
yarn install
# or
pnpm install
  1. Run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
  1. Open http://localhost:3000 with your browser to see the result.

Project Structure

src/
├── app/
│   ├── page.tsx          # Landing page
│   ├── docs/
│   │   └── page.tsx      # Documentation
│   ├── api/
│   │   └── page.tsx      # API Reference
│   ├── examples/
│   │   └── page.tsx      # Code Examples
│   ├── layout.tsx        # Root layout
│   └── globals.css       # Global styles

Pages

Landing Page (/)

  • Hero section with value proposition
  • Feature highlights
  • Use cases showcase
  • Call-to-action sections
  • Footer with links

Documentation (/docs)

  • Getting started guide
  • Quick start instructions
  • Authentication setup
  • Wallet management
  • External wallet verification
  • Configuration options
  • Architecture overview

API Reference (/api)

  • Complete API endpoint documentation
  • Request/response examples
  • Authentication methods
  • Error handling
  • Status codes

Examples (/examples)

  • Basic wallet operations
  • Payment flow examples
  • External wallet verification
  • SDK examples (JavaScript, Python, Go)
  • Webhook integration

Customization

Styling

The project uses Tailwind CSS for styling. You can customize the design by:

  • Modifying the color scheme in tailwind.config.js
  • Updating component styles in the respective page files
  • Adding custom CSS in globals.css

Content

  • Update the landing page content in src/app/page.tsx
  • Modify documentation in src/app/docs/page.tsx
  • Update API reference in src/app/api/page.tsx
  • Add new examples in src/app/examples/page.tsx

Deployment

Vercel (Recommended)

  1. Push your code to GitHub
  2. Connect your repository to Vercel
  3. Deploy automatically

Other Platforms

The project can be deployed to any platform that supports Next.js:

  • Netlify
  • AWS Amplify
  • Railway
  • DigitalOcean App Platform

Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes and add tests
  4. Commit your changes: git commit -m 'Add amazing feature'
  5. Push to the branch: git push origin feature/amazing-feature
  6. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Related Projects

Repository Information

Based on the official QuasarFlow API repository:

  • Language Distribution: Go (72.2%), Shell (26.9%), Dockerfile (0.9%)
  • Repository Stats: 0 stars, 2 forks, 10 commits
  • License: MIT License
  • Architecture: Clean Architecture with Go 1.21+
  • Database: PostgreSQL
  • Blockchain: Stellar Network integration
  • Deployment: Docker and Docker Compose support

QuasarFlow - Making blockchain development simple and accessible for everyone.

About

Official Website of the Quasar Flow Protocol

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published