Skip to content

Commit 7d407fd

Browse files
committed
chore: update README.md
1 parent c7cc7f8 commit 7d407fd

4 files changed

Lines changed: 14 additions & 4 deletions

File tree

.github/workflows/latest_changes.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ on:
1010
workflow_dispatch:
1111

1212
jobs:
13-
run-script:
13+
update_readme:
1414
runs-on: ubuntu-latest
1515
steps:
1616
- name: Checkout main branch
1717
uses: actions/checkout@v4
1818
with:
1919
ref: 'main'
2020
fetch-depth: 0
21-
token: ${{ secrets.GITHUB_TOKEN }}
21+
token: ${{ secrets.ATTICUS_PAT }}
2222

2323
- name: Configuring git credentials
2424
run: |

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,16 @@ ___
5959
___
6060
![](assets/usage.gif)
6161

62-
1. create your github repo and clone your repo
63-
62+
1. create your github repo and config it
63+
1. allow ci to access your repo
64+
![img.png](assets/img.png)
65+
2. config ci_tokens
66+
1. `CODECOV_TOKEN` for codecov in `.github/workflows/ci.yml` ,`semantic-release` is optional for auto release
67+
2. `ATTICUS_PAT`should replace with your GitHub token for latest_changes.yml in `.github/workflows/latest_changes.yml`
68+
3. `DOCKER_USERNAME` and `DOCKER_PASSWORD` for docker-image.yml in `.github/workflows/docker-image.yml`
69+
4. replace `tags: atticuszhou/supafast:latest` with your docker repo in `.github/workflows/docker-image.yml`
70+
3. config fastapi setting in `your_project\src\app\core\config.py`
71+
4. config `pyproject.toml` with your project name and description,etc
6472
2. cd your repo and install dependencies
6573

6674
```shell
@@ -71,6 +79,8 @@ poetry install
7179
```shell
7280
export SUPABASE_URL=your_supabase_url
7381
export SUPABASE_KEY=your_supabase_key
82+
export SUPERUSER_EMAIL=your_superuser_email
83+
export SUPERUSER_PASSWORD=your_superuser_password
7484
```
7585
4. config fastapi settings
7686
```python

assets/img.png

58.3 KB
Loading

img.png

-379 KB
Binary file not shown.

0 commit comments

Comments
 (0)