structure

Author: ProFastCode

.github/workflows/structure-to-readme.yml

@@ -0,0 +1,34 @@
+name: Update README with File Structure
+
+on:
+ push:
+ branches:
+ - main
+
+permissions:
+ contents: write
+
+jobs:
+ update-readme:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v2
+
+ - name: Update README.md
+ uses: actions/github-script@v6
+ with:
+ script: |
+ const { execSync } = require('child_process');
+ const fs = require('fs');
+
+ const fileStructure = execSync('cd app && tree').toString();
+
+ const readmePath = 'README.md';
+ let readmeContent = fs.readFileSync(readmePath, 'utf8');
+ readmeContent = readmeContent.replace(/## File Structure.*?(?=## |$)/s, '## File Structure\n```\n' + fileStructure + '```\n\n');
+ fs.writeFileSync(readmePath, readmeContent);
+
+ - uses: EndBug/add-and-commit@v9
+ with:
+ default_author: github_actions

README.md

@@ -1,6 +1,52 @@
-# FastAPI Template
+# FastAPI
 
-**Create a .env file based on .env.dist and make all the necessary customizations.**
+## File Structure
+```
+.
+├── __init__.py
+├── api
+│   ├── __init__.py
+│   ├── deps.py
+│   └── v1
+│   ├── __init__.py
+│   └── users
+│   ├── __init__.py
+│   ├── auth
+│   │   ├── __init__.py
+│   │   └── token.py
+│   ├── create.py
+│   └── retrieve.py
+├── core
+│   ├── __init__.py
+│   ├── db.py
+│   ├── exps.py
+│   └── settings.py
+├── logic
+│   ├── __init__.py
+│   ├── security
+│   │   ├── __init__.py
+│   │   ├── jwt.py
+│   │   └── pwd.py
+│   └── users
+│   ├── __init__.py
+│   ├── auth
+│   │   ├── __init__.py
+│   │   └── auth.py
+│   └── users.py
+├── models
+│   ├── __init__.py
+│   ├── base.py
+│   ├── token.py
+│   └── user.py
+└── repositories
+ ├── __init__.py
+ ├── abstract.py
+ └── user.py
+
+11 directories, 28 files
+```
+
+## Create a `.env` file based on `.env.dist` and make all the necessary customizations
 
 ### To run the application in a docker container, run the command
 

temp_structure.md

@@ -0,0 +1,30 @@
+## File Structure
+.
+├── Dockerfile
+├── LICENSE
+├── Makefile
+├── README.md
+├── alembic.ini
+├── app
+│   ├── __init__.py
+│   ├── api
+│   ├── core
+│   ├── logic
+│   ├── models
+│   └── repositories
+├── docker-compose.yaml
+├── docs
+│   ├── index.html
+│   ├── openapi.json
+│   └── swagger.html
+├── migrations
+│   ├── README
+│   ├── env.py
+│   ├── script.py.mako
+│   └── versions
+├── poetry.lock
+├── pyproject.toml
+├── requirements.txt
+└── temp_structure.md
+
+9 directories, 17 files