Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/5ouma/mobicard

📇 Turn your smartphone into a name card
https://github.com/5ouma/mobicard

android astro astrobook biome bun card ios name-card pwa typescript vite vitest

Last synced: 5 days ago
JSON representation

📇 Turn your smartphone into a name card

Host: GitHub
URL: https://github.com/5ouma/mobicard
Owner: 5ouma
License: mit
Created: 2024-11-07T10:20:06.000Z (about 2 months ago)
Default Branch: main
Last Pushed: 2024-12-22T19:51:44.000Z (12 days ago)
Last Synced: 2024-12-22T20:31:30.523Z (12 days ago)
Topics: android, astro, astrobook, biome, bun, card, ios, name-card, pwa, typescript, vite, vitest
Language: TypeScript
Homepage: https://mobicard.pages.dev
Size: 9.74 MB
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 6
Metadata Files:
- Readme: .github/README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
Mobicard




**📇 Turn your smartphone into a name card**

[![GitHub Release](https://img.shields.io/github/v/release/5ouma/mobicard?style=flat-square)](https://github.com/5ouma/mobicard/releases)




![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/5ouma/mobicard?style=flat-square)

![GitHub repo size](https://img.shields.io/github/repo-size/5ouma/mobicard?style=flat-square)

[![GitHub last commit](https://img.shields.io/github/last-commit/5ouma/mobicard?style=flat-square)](https://github.com/5ouma/mobicard/commit/HEAD)

[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/5ouma/mobicard?style=flat-square)](https://github.com/5ouma/mobicard/commits/main)




[![CI](https://img.shields.io/github/actions/workflow/status/5ouma/mobicard/ci.yml?label=ci&style=flat-square)](https://github.com/5ouma/mobicard/actions/workflows/ci.yml)

[![Release](https://img.shields.io/github/actions/workflow/status/5ouma/mobicard/release.yml?label=release&style=flat-square)](https://github.com/5ouma/mobicard/actions/workflows/release.yml)

[![pre-commit](https://img.shields.io/github/actions/workflow/status/5ouma/mobicard/pre-commit.yml?label=pre-commit&style=flat-square)](https://github.com/5ouma/mobicard/actions/workflows/pre-commit.yml)

[![codecov](https://codecov.io/github/5ouma/mobicard/graph/badge.svg)](https://codecov.io/github/5ouma/mobicard)







## 📊 Usage

1. Create a new project with `mobicard` template

   ```sh

   npm create astro --template 5ouma/mobicard

   ```

2. Copy the [`meta.tmpl.json`] to `meta.json` and edit as you prefer

   > [👾 Meta File](#-meta-file)

3. Build and Preview the project

   ```sh

   bun run build

   ```

   ```sh

   bun run preview

   ```





## 🔨 Development

1. Clone this repository

   ```sh

   git clone https://github.com/5ouma/mobicard.git

   ```

2. Copy the [`meta.tmpl.json`] to `meta.json` and edit as you prefer

   > [👾 Meta File](#-meta-file)

3. Run the development server

   ```sh

   # Run the development server

   bun run dev

   ```

   ```sh

   # Run the Astrobook

   bun run astrobook

   ```





## 👾 Meta File

```json

{

  "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"

}

```

[`meta.tmpl.json`]: ../meta.tmpl.json

> [!NOTE]

> Valid contact services are:

>

> - Bluesky

> - Facebook

> - GitHub

> - Instagram

> - Mastodon

> - Misskey

> - Posts

> - Threads

> - Twitter

> - YouTube





## 🆘 Help

- [**⚠️ Issues**]: Feature Requests or Bug Reports

- [**💬 Discussions**]: General Chats or Questions

- [**🛡️ Security Advisories**]: Security Issues that should not be public

[**⚠️ Issues**]: https://github.com/5ouma/mobicard/issues/new/choose

[**💬 Discussions**]: https://github.com/5ouma/mobicard/discussions/new/choose

[**🛡️ Security Advisories**]: https://github.com/5ouma/mobicard/security/advisories/new





## 🎽 Contributing

I happily welcome your contributions!

Before you contribute,

I would recommend reading [CONTRIBUTING.md](./CONTRIBUTING.md)

for a better development experience.