Browse Source

updated readme with new project structure

cli-archive
nic 2 years ago
parent
commit
2ec532bd93
  1. 92
      Readme.md

92
Readme.md

@ -3,90 +3,68 @@
## Project Structure
```project_root/
├── apps/
├── cmd/
│ ├── cli/
│ │ └── main.go
│ └── web/
│ └── main.go
├── internal/
│ ├── api/
│ │ └── api.go
| | └── attachments.go (will be removed)
| | └── auth.go (will be removed)
| | └── common.go (will be removed)
| | └── deficiencies.go
│ ├── auth/
│ │ └── auth.go (may be removed, idk if it should be in the api or be here by itself)
│ ├── handlers/ (for web)
│ │ ├── api.go
│ │ ├── auth.go
│ │ ├── jobs.go
│ │ ├── invoices.go
│ │ └── deficiencies.go
│ ├── handlers/
│ │ ├── web/
│ │ │ ├── admin.go
│ │ │ ├── assets.go
│ │ │ ├── auth.go
│ │ │ ├── companies.go
│ │ │ ├── contacts.go
│ │ │ ├── contracts.go
│ │ │ ├── dashboard.go
│ │ │ ├── generic.go
│ │ │ ├── invoices.go
│ │ │ ├── jobs.go
│ │ │ ├── locations.go
│ │ │ ├── notifications.go
│ │ │ ├── quotes.go
│ │ │ ├── services.go
│ │ │ ├── tags.go
│ │ │ └── users.go
│ │ └── cli/
│ │ ├── admin.go
│ │ ├── assets.go
│ │ ├── companies.go
│ │ ├── contacts.go
│ │ ├── contracts.go
| | └── dashboard.go
│ │ ├── generic.go
│ │ ├── invoices.go
│ │ ├── jobs.go
│ │ ├── locations.go
| | └── login.go
│ │ ├── notifications.go
│ │ ├── quotes.go
│ │ ├── services.go
│ │ ├── tags.go
│ │ └── users.go
│ ├── menu/ (in both cli and web (☉__☉”))
│ │ ├── admin.go (need to create)
│ │ ├── assets.go (need to create)
│ │ ├── companies.go (need to create)
│ │ ├── contacts.go (need to create)
│ │ ├── contracts.go (need to create)
│ │ ├── generic.go (need to create)
│ │ ├── invoices.go (need to create)
│ │ ├── jobs.go
│ │ ├── locations.go (need to create)
| | ├── menu.go
│ │ ├── notifications.go (need to create)
│ │ ├── quotes.go (need to create)
│ │ ├── services.go (need to create)
│ │ ├── tags.go (need to create)
│ │ └── users.go (need to create)
│ ├── middleware/
│ │ └── auth_middleware.go
│ └── models/
│ └── models.go
│ ├── models/
│ │ └── models.go
│ └── utils/
│ ├── ui.go
│ └── utils.go
├── static/
│ ├── css/
│ │ └── styles.css
── js/
| └─ htmx.min.js
│ └── js/
│ └── htmx.min.js
├── templates/
│ ├── layout.html
│ ├── login.html
│ ├── dashboard.html
│ ├── partials/
│ │ └── admin.html
│ │ └── assets.html
│ │ └── companies.html
│ │ └── invoice_search_results.html
│ │ └── invoice_search.html
│ │ └── jobs.html
│ ├── admin.html (need to create)
│ ├── assets.html (need to create)
│ ├── companies.html (need to create)
│ ├── contacts.html (need to create)
│ ├── contracts.html (need to create)
│ ├── generic.html (need to create)
│ ├── invoices.html (need to create)
│ └── partials/
│ ├── jobs.html
│ ├── locations.html (need to create)
│ ├── notifications.html (need to create)
│ ├── quotes.html (need to create)
│ ├── services.html (need to create)
│ ├── tags.html (need to create)
│ └── users.html (need to create)
├── ui/
| | └── ui.go (for cli)
├── utils/
| | └── utils.go (for cli)
│ ├── invoices.html
│ └── ...
└── go.mod
```

Loading…
Cancel
Save