version-0.1 #1
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 James Wampler
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
42
readme.md
42
readme.md
@@ -0,0 +1,42 @@
|
||||
# MicCheck
|
||||
|
||||
Open source feature flag management platform. Manage projects, environments, feature flags, segments, and identities across your apps.
|
||||
|
||||
Built with .NET (API) and Vue.js + Vuetify (admin UI).
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
src/
|
||||
api/MicCheck.Api/ .NET API — REST endpoints, organized by feature (Features, Projects, Environments,
|
||||
Segments, Identities, Organizations, Webhooks, Audit, Users)
|
||||
admin/ Vue.js + Vuetify admin SPA
|
||||
MicCheck.AppHost/ .NET Aspire orchestration host for local dev
|
||||
MicCheck.ServiceDefaults/ Shared .NET Aspire service defaults (telemetry, health checks)
|
||||
tests/
|
||||
api/MicCheck.Api.Tests.Unit/ Unit tests
|
||||
api/MicCheck.Api.Tests.Integration/ Integration tests
|
||||
docs/
|
||||
admin/ Admin implementation plans/output docs
|
||||
api/ API implementation plans/output docs
|
||||
```
|
||||
|
||||
Code in the API is organized by feature area (e.g. `Features`, `Segments`, `Identities`) rather than by technical layer.
|
||||
|
||||
## Running locally
|
||||
|
||||
`docker-compose.yml` provides supporting services. `MicCheck.AppHost` (.NET Aspire) orchestrates the API and admin app for local development.
|
||||
|
||||
```sh
|
||||
./dev-build.sh
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
```sh
|
||||
dotnet test
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT — see [LICENSE](LICENSE).
|
||||
|
||||
Reference in New Issue
Block a user