README
¶
Accretion
⚠️ WARNING: Not production ready code, instead a Code Kata intended to hone my programming skills through practice and repetition.
Manage internal technical documentation that is enriched with live data accreted from your environment.
Getting Started
nvm use && make && ./accretion
Verification
Linting
make lint
These rules can then be automatically applied:
make format
Unit Testing
make test
Design
Repository Structure
| Directory | Purpose |
|---|---|
./.github/workflows |
GitHub Actions workflow definitions. |
./cmd/accretion |
The CLI is used for both running the server core and for interacting with the server core over GraphQL. |
./graphql |
The channel of communication with the server core used by all other interaction methods, along with 3rd party services. |
./internal/domain |
Code that defines the core application logic. |
./internal/gateway |
Defines how the domain interfaces with external systems. |
./schema.graphql |
|
./spa |
A Vue client application that interacts with the server core via GraphQL. |
Persistence
The source of truth is a series of HistoricalFact events that are processed to form multiple projections including
a SearchProjection and GraphProjection. Each projection is specifically designed to support different use cases.
Security
See the Security Policy.
References
- Add Icons with Vue
- Fontawesome Icons
- Go GraphQL
- Gofmt
- GraphQL
- Pinia
- Prettier
- Vite
- Vitest
- Vue Router
- Vue Testing Utils
- Vue
License
The MIT License is used by this project.
Directories
Click to show internal directories.
Click to hide internal directories.