docs: Add file tree structure
							parent
							
								
									fb050214b9
								
							
						
					
					
						commit
						fdfb9a3e5c
					
				
								
									
									
										
											14
										
									
									README.md
									
									
									
									
								
								
							
							
										
											14
										
									
									README.md
									
									
									
									
								| 
						 | 
					@ -19,6 +19,18 @@ Schedule and availability system for Team Fortress 2 teams.
 | 
				
			||||||
- **Database:** [PostgreSQL 17.1](https://www.postgresql.org/docs/17/index.html)
 | 
					- **Database:** [PostgreSQL 17.1](https://www.postgresql.org/docs/17/index.html)
 | 
				
			||||||
  (production) / SQLite (development)
 | 
					  (production) / SQLite (development)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## File Structure
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					availabili.tf/               root
 | 
				
			||||||
 | 
					├── availabili.tf/           frontend (Vue.js)
 | 
				
			||||||
 | 
					├── backend-flask/           backend/software layer (Python)
 | 
				
			||||||
 | 
					├── nginx/                   reverse proxy
 | 
				
			||||||
 | 
					├── docker-compose.prod.yml  production environment
 | 
				
			||||||
 | 
					├── docker-compose.yml       development environment
 | 
				
			||||||
 | 
					└── README.md                this file
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Setup (production, Postgres)
 | 
					## Setup (production, Postgres)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Build the frontend app, assuming Node.js is installed:
 | 
					Build the frontend app, assuming Node.js is installed:
 | 
				
			||||||
| 
						 | 
					@ -41,7 +53,7 @@ Perform initial database migration. This is for automatically setting up the
 | 
				
			||||||
database schema for the first time:
 | 
					database schema for the first time:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```sh
 | 
					```sh
 | 
				
			||||||
docker exec -it backend bash
 | 
					docker exec -it backend-flask-production bash
 | 
				
			||||||
flask db upgrade
 | 
					flask db upgrade
 | 
				
			||||||
exit
 | 
					exit
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,21 +0,0 @@
 | 
				
			||||||
{
 | 
					 | 
				
			||||||
  "name": "availabili.tf",
 | 
					 | 
				
			||||||
  "lockfileVersion": 3,
 | 
					 | 
				
			||||||
  "requires": true,
 | 
					 | 
				
			||||||
  "packages": {
 | 
					 | 
				
			||||||
    "": {
 | 
					 | 
				
			||||||
      "dependencies": {
 | 
					 | 
				
			||||||
        "v-dropdown-menu": "^2.0.4"
 | 
					 | 
				
			||||||
      }
 | 
					 | 
				
			||||||
    },
 | 
					 | 
				
			||||||
    "node_modules/v-dropdown-menu": {
 | 
					 | 
				
			||||||
      "version": "2.0.4",
 | 
					 | 
				
			||||||
      "resolved": "https://registry.npmjs.org/v-dropdown-menu/-/v-dropdown-menu-2.0.4.tgz",
 | 
					 | 
				
			||||||
      "integrity": "sha512-YPHnx29YWVSdRO8IZcIKNCmSx2jFOkU/5Jyv8pN7P/z2Jif/L6Xto3J29LwIhday1zwMI5sjmU5bNMbBnmdg0A==",
 | 
					 | 
				
			||||||
      "license": "MIT",
 | 
					 | 
				
			||||||
      "engines": {
 | 
					 | 
				
			||||||
        "node": ">=12"
 | 
					 | 
				
			||||||
      }
 | 
					 | 
				
			||||||
    }
 | 
					 | 
				
			||||||
  }
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
		Loading…
	
		Reference in New Issue