Browse Source

updated readme with new project structure

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

142
Readme.md

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

Loading…
Cancel
Save