Skip to content

5ouma/mobicard

Repository files navigation

Mobicard

πŸ“‡ Turn your smartphone into a name card

GitHub Release
GitHub code size in bytes GitHub repo size GitHub last commit GitHub commit activity
CI Release pre-commit.ci status codecov



πŸ“Š Usage

  1. Create a new project with mobicard template

    npm create astro --template 5ouma/mobicard
  2. Copy the meta.tmpl.json to meta.json and edit as you prefer

    πŸ‘Ύ Meta File

  3. Build and Preview the project

    bun run build
    bun run preview



πŸ”¨ Development

  1. Clone this repository

    git clone https://github.com/5ouma/mobicard.git
  2. Copy the meta.tmpl.json to meta.json and edit as you prefer

    πŸ‘Ύ Meta File

  3. Run the development server

    # Run the development server
    bun run dev
    # Run the Astrobook
    bun run astrobook



πŸ‘Ύ Meta File

{
  "name": "Your Name",
  "description": "Your Description",
  "icon": "Your Icon URL",
  "homepage": "Your Homepage URL",
  "email": "Your Email",
  "sns": [{ "service": "Service Name", "id": "Your ID" }],
  "card": "Your Card URL"
}

Note

Valid contact services are:

  • Bluesky
  • Facebook
  • GitHub
  • Instagram
  • Mastodon
  • Misskey
  • Posts
  • Threads
  • Twitter
  • YouTube



πŸ†˜ Help



🎽 Contributing

I happily welcome your contributions! Before you contribute, I would recommend reading CONTRIBUTING.md for a better development experience.