Skip to content

Commit 38206e7

Browse files
committed
✨ Update README.md to include additional badges and enhance quick start instructions
1 parent 645006a commit 38206e7

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
1-
# Gitea Mirror
1+
<!-- Badges -->
2+
<p align="center">
3+
<a href="https://github.com/arunavo4/gitea-mirror/releases/latest"><img src="https://img.shields.io/github/v/tag/arunavo4/gitea-mirror?label=release"/></a>
4+
<a href="https://github.com/arunavo4/gitea-mirror/actions/workflows/astro-build-test.yml"><img src="https://img.shields.io/github/actions/workflow/status/arunavo4/gitea-mirror/astro-build-test.yml?branch=main"/></a>
5+
<a href="https://github.com/arunavo4/gitea-mirror/pkgs/container/gitea-mirror"><img src="https://img.shields.io/badge/ghcr.io-container-blue?logo=github"/></a>
6+
<a href="https://github.com/arunavo4/gitea-mirror/blob/main/LICENSE"><img src="https://img.shields.io/github/license/arunavo4/gitea-mirror"/></a>
7+
</p>
28

9+
# Gitea Mirror
310

411
<p align="center">
512
<i>A modern web application for automatically mirroring repositories from GitHub to your self-hosted Gitea instance.</i><br>
613
<sub>Designed for developers, teams, and organizations who want to retain full control of their code while still collaborating on GitHub.</sub>
714
</p>
815

16+
## 🚀 Quick Start
17+
18+
```bash
19+
docker compose --profile production up -d
20+
# or
21+
pnpm setup && pnpm dev
22+
```
23+
924
<p align="center">
1025
<img src=".github/assets/dashboard.png" alt="Dashboard" width="80%"/>
1126
</p>
@@ -330,12 +345,12 @@ docker compose -f docker-compose.dev.yml up -d
330345

331346
> [!TIP]
332347
> You can also create a `.env` file with your GitHub and Gitea credentials:
333-
>
348+
>
334349
> ```env
335350
> # GitHub credentials
336351
> GITHUB_TOKEN=your-github-token
337352
> GITHUB_USERNAME=your-github-username
338-
>
353+
>
339354
> # Gitea credentials (will be set up after you create a user in the local Gitea instance)
340355
> GITEA_TOKEN=your-local-gitea-token
341356
> GITEA_USERNAME=your-local-gitea-username
@@ -385,14 +400,14 @@ This project is now complete and ready for production use with version 1.0.0. Al
385400
386401
> [!WARNING]
387402
> If you encounter network-related warnings or errors when running Docker Compose, such as:
388-
>
403+
>
389404
> ```
390405
> WARN[0095] a network with name gitea-network exists but was not created by compose.
391406
> Set `external: true` to use an existing network
392407
> ```
393-
>
408+
>
394409
> or
395-
>
410+
>
396411
> ```
397412
> network gitea-network was found but has incorrect label com.docker.compose.network set to "" (expected: "gitea-network")
398413
> ```
@@ -416,7 +431,7 @@ Try the following steps:
416431

417432
> [!TIP]
418433
> If you need to share the network with other Docker Compose projects, you can modify the `docker-compose.dev.yml` file to mark the network as external:
419-
>
434+
>
420435
> ```yaml
421436
> networks:
422437
> gitea-network:
@@ -428,7 +443,7 @@ Try the following steps:
428443
429444
> [!CAUTION]
430445
> If the application fails to connect to Redis with errors like `ECONNREFUSED 127.0.0.1:6379`, ensure:
431-
>
446+
>
432447
> 1. The Redis container is running:
433448
> ```bash
434449
> docker ps | grep redis
@@ -494,13 +509,13 @@ redis.on('error', (err) => console.error('Redis client error:', err));
494509

495510
> [!TIP]
496511
> If containers are not starting properly, check their health status:
497-
>
512+
>
498513
> ```bash
499514
> docker ps --format "{{.Names}}: {{.Status}}"
500515
> ```
501-
>
516+
>
502517
> For more detailed logs:
503-
>
518+
>
504519
> ```bash
505520
> docker logs gitea-mirror-dev
506521
> ```

0 commit comments

Comments
 (0)