Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance the procedure #49

Merged
merged 2 commits into from
Nov 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 32 additions & 24 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,47 +22,51 @@

## 📊 Usage

1. Clone this repository
1. Create a new project with `mobicard` template

```sh
git clone https://github.com/5ouma/mobicard.git
npm create astro --template 5ouma/mobicard
```

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

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

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

3. Install the dependencies
3. Build and Preview the project

```sh
bun install
bun run build
```

4. Build or Run the development server
```sh
bun run preview
```

- For production
<br /><br />

1. Build the project
## 🔨 Development

```sh
bun run build
```
1. Clone this repository

2. Deploy the created `dist` directory
```sh
git clone https://github.com/5ouma/reproxy.git
```

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

```sh
# Run the development server
bun run dev
```
> [👾 Meta File](#-meta-file)

3. Run the development server

```sh
# Run the development server
bun run dev
```

```sh
# Run the Astrobook
bun run astrobook
```
```sh
# Run the Astrobook
bun run astrobook
```

<br /><br />

Expand All @@ -73,11 +77,15 @@
"name": "Your Name",
"description": "Your Description",
"icon": "Your Icon URL",
"contacts": [{ "service": "Service Name", "id": "Your ID" }],
"homepage": "Your Homepage 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:
>
Expand Down