Skip to content

Commit

Permalink
Merge pull request #12 from databases-CSCI3354/update-readme
Browse files Browse the repository at this point in the history
State folder structure in README.md
  • Loading branch information
jinyang628 authored Feb 11, 2025
2 parents 0db5d3d + 1cdcffc commit b22cd54
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,18 @@ flask run

# To verify that the app is running, go to the /status endpoint
```

## Folder Structure

```bash
├── app/
│ ├── models/ # Data models used across the application
│ ├── routes/ # Routes handle the HTTP requests and render the appropriate templates (no business logic)
│ ├── services/ # Services handle the business logic of the application
│ ├── static/ # Static files like CSS
│ ├── templates/ # Jinja templates
│ ├── utils/ # Utility functions that are used across the entire application
│ ├── northwind.db # Built database file
│ └── run.py # Main executuable file
└── tests/ # Tests for each file are labelled with the file name
```

0 comments on commit b22cd54

Please sign in to comment.