Skip to content

Commit b0ac939

Browse files
Update dir structure in docs
1 parent 5e44fe6 commit b0ac939

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

README.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,10 @@ _TODO: add features!_
2828
TODO: add more instructions for updating the project configuration!
2929

3030
3. Start development:
31-
```shell
32-
# Set up repository
33-
git init
34-
git add .
35-
# Run all checks
36-
bb check
37-
# Commit initial changes
38-
git commit -m "Initial commit"
39-
```
40-
4131
Manage project and start server from built-in REPL:
4232
```shell
43-
# Show all available tasks
44-
bb tasks
45-
bb check
33+
cd myproject
34+
# Run server in dev mode
4635
bb repl
4736
(reset)
4837
```
@@ -54,24 +43,47 @@ _TODO: add features!_
5443

5544
The template generates a Clojure project with the following structure:
5645

57-
; TODO: provide actual project structure!
46+
5847
```
59-
├── .clj-kondo/ # Clojure linting configuration
48+
├── .clj-kondo/ # Clojure linting cache, imports and configuration
49+
│ └── config.edn # Clojure linting configuration
6050
├── .github/ # GitHub Actions workflows and configurations
51+
│ ├── actions/ # Common actions for workflows
52+
│ └── workflows/ # GitHub Actions workflow definitions
53+
│ ├── checks.yaml # Lint, format, test and check outdated deps on push
54+
│ └── deploy.yaml # Deployment workflow
55+
├── .kamal/ # Kamal secrets template (_only used if you use Kamal_)
56+
├── config/ # Kamal deployment configuration (_only used if you use Kamal_)
57+
├── db/ # Database files directory (_only used if you use SQLite_)
6158
├── dev/ # Development configuration directory
6259
│ └── user.clj # User-specific development configuration
60+
├── resources/ # Static resources and configuration files
61+
│ ├── public/ # Public assets (CSS, JS, images)
62+
│ ├── migrations/ # Database migration files
63+
│ ├── config.edn # Main configuration file for the application
64+
│ ├── config.dev.edn # Development-specific configuration
65+
│ ├── config.e2e.edn # Test-specific configuration for end-to-end testing
66+
│ └── logback.xml/ # Logging configuration file
6367
├── src/ # Source code directory
6468
│ └── {{name}} # Main namespace directory
65-
│ └── core.clj # Main namespace file
69+
│ ├── core.clj # Application entry point
70+
│ ├── db.clj # Database system component and main operations
71+
│ ├── handlers.clj # HTTP request handlers
72+
│ ├── routes.clj # Route definitions
73+
│ ├── server.clj # Server system component
74+
│ └── views.clj # HTML templates and components with Hiccup
6675
├── test/ # Test files directory
6776
│ └── {{name}} # Test namespace directory
68-
│ └── core_test.clj # Test namespace file
77+
│ ├── home_test.clj # Example test for home page
78+
│ ├── test_utils.clj # Test utilities
79+
│ └── webdriver.clj # Webdriver system component to be used in `config.e2e.edn`
6980
├── .cljfmt.edn # Formatting configuration
7081
├── .gitignore # Git ignore rules
71-
├── .mise.toml # mise-en-place configuration with system tools versions
72-
├── bb.edn # Babashka tasks configuration
82+
├── .mise.toml # mise-en-place configuration with system dependencies
83+
├── bb.edn # Babashka tasks configuration for managing application
7384
├── deps.edn # Clojure dependencies and aliases
74-
├── LICENSE # License file
85+
├── Dockerfile # Dockerfile for building the application image
86+
├── LICENSE # License file, AGPLv3 by default
7587
└── README.md # Project documentation
7688
```
7789

0 commit comments

Comments
 (0)