Skip to content

Commit

Permalink
Add project layout docs
Browse files Browse the repository at this point in the history
  • Loading branch information
scalalang2 committed Feb 14, 2023
1 parent 9aeb1cb commit 6535aa9
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ $ ./bin/server --config-file ./config-server.yml

## Docs
- [System Design](./docs/design.md)
- [Project Structure](./docs/project_structure.md)

## Contribution
If you are interested in contributing to this project,
Expand Down
18 changes: 18 additions & 0 deletions docs/project_structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Project Structure
This page describes how project layout is organized.

```shell
.
├── cmd
│ └── cosmscan : (main package)
├── internel : (internal packages)
│ ├── db : defines postgres database object
│ ├── client : defines cosmos & tendermint client
│ └── config : defines global configuration object
├── proto : protobuf files are defined in here
├── modules
│ ├── server : represents API server based on gRPC & HTTP protocol
│ └── indexer : represents indexer engine
├── pkg : useful util functions are defined in here
└── example : anyone can launch cosmscan with this example in local machine.
```

0 comments on commit 6535aa9

Please sign in to comment.