Update README

Signed-off-by: gearnode <bryan@frimin.fr>
This commit is contained in:
gearnode
2025-02-22 10:04:17 +01:00
parent be44235263
commit b4b9593ac5
2 changed files with 161 additions and 35 deletions

BIN
.github/cover.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 712 KiB

196
README.md
View File

@@ -1,57 +1,183 @@
![probo banner](https://raw.githubusercontent.com/getprobo/.github/main/profile/banner.png) <div align="center">
<h1>Probo - Open Source Compliance</h1>
## Why another compliance platform? ![probo banner](.github/cover.png)
We build Probo for three reasons: [![Discord](https://img.shields.io/discord/1326589224811757568?color=7289da&label=Discord&logo=discord&logoColor=ffffff)](https://discord.gg/8qfdJYfvpY)
[![GitHub License](https://img.shields.io/github/license/getprobo/probo)](LICENSE)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/getprobo/probo/make.yaml)
**Existing solutions are behind a paywall and too expensive.** Compliance frameworks often push good practices, the security measures should be accessible to all. </div>
**Reinvent the journey.** We want to start from scratch, exploiting past issues to craft a new experience. Probo is an open-source compliance platform built for startups that helps you achieve SOC-2 compliance quickly and efficiently. Unlike traditional solutions, Probo is designed to be accessible, transparent, and community-driven.
**We believe in Open-source and community.** It impacts almost all companies, the whole ecosystem should benefit from it. ## ✨ Features
## What can you do with Probo today? - ⚡️ **Lightning-Fast Automation**
Not much yet. But it is only the beginning of the journey.
So far, you have access to **all the security measures necessary to prepare a SOC 2 audit**.
Soon, we will add: - Get SOC-2 ready in just 20 hours instead of months
- End-to-end platform - AI-powered policy generation tailored to your stack
- Personnalized policy generation (based on the security measure implemented) - Automated evidence collection from your tools
- Integration with Google Workplaces, Github, GCP & AWS
- Support for ISO 27001 and GDPR
## Tech Stack - 🤖 **Smart Vendor Management**
Probo is built with the following technologies: - Automagic vendor risk assessment in minutes
- AI-driven security questionnaire responses
- Continuous vendor monitoring and alerts
**Backend:** - 🔄 **Continuous Compliance**
- [Go](https://go.dev/) for the API server
- [PostgreSQL](https://www.postgresql.org/) for data storage - Real-time compliance monitoring
- [GraphQL](https://graphql.org/) for the API layer - Automated evidence collection from GitHub, AWS, GCP
- Instant alerts for compliance drift
- 💡 **Intelligent Guidance**
- AI-powered compliance recommendations
- Context-aware security controls
- Smart task prioritization based on your risk profile
- 🔓 **No Vendor Lock-in**
- Own your compliance data
- Export everything, anytime
- Open-source transparency
- 💰 **Cost-Effective**
- Free to use
- Pay only for audits when needed
- No hidden fees or forced costs
## 🚀 Getting Started
### Prerequisites
- Go 1.21+
- Node.js 22+
- Docker
### Quick Start
1. Clone the repository:
```bash
git clone https://github.com/getprobo/probo.git
cd probo
```
2. Install dependencies:
```bash
# Install Go dependencies
go mod download
# Install Node.js dependencies
npm ci
```
3. Start the development environment:
```bash
# Start infrastructure services
make stack-up
# Build the project
make build
# In one terminal - start the API server
bin/probod
# In another terminal - start the frontend
npm -w @probo/console run dev
```
The application will be available at:
- Frontend: http://localhost:3000
- API: http://localhost:8080
- Grafana: http://localhost:3001
For detailed setup instructions, see our [Contributing Guide](CONTRIBUTING.md).
## 🏗️ Current Status
Probo is in early development, focusing on building a solid foundation for compliance management. Here's our current focus:
### Under Development (V0)
- 🎯 **Core Compliance Engine**
- SOC 2 control framework implementation
- Basic policy management
- Evidence collection system
- User and organization management
- 📋 **Essential Features**
- Control tracking and status
- Basic task management
- Simple evidence attachments
- Team collaboration tools
## 🛠️ Tech Stack
### Backend
- [Go](https://go.dev/) - API server
- [PostgreSQL](https://www.postgresql.org/) - Data storage
- [GraphQL](https://graphql.org/) - API layer
### Frontend
**Frontend:**
- [React](https://react.dev/) with [TypeScript](https://www.typescriptlang.org/) - [React](https://react.dev/) with [TypeScript](https://www.typescriptlang.org/)
- [Relay](https://relay.dev/) for data fetching - [Relay](https://relay.dev/) - Data fetching
- [TailwindCSS](https://tailwindcss.com/) for styling - [TailwindCSS](https://tailwindcss.com/) - Styling
**Infrastructure:** ### Infrastructure
- [Docker](https://www.docker.com/) for containerization
- [OpenTelemetry](https://opentelemetry.io/) for observability
- [GitHub Actions](https://github.com/features/actions) for CI/CD
## Contributing - [Docker](https://www.docker.com/) - Containerization
- [OpenTelemetry](https://opentelemetry.io/) - Observability
- [GitHub Actions](https://github.com/features/actions) - CI/CD
We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) for details. ### Observability
## Join the community - Grafana - Metrics visualization
- Prometheus - Metrics collection
- Loki - Log aggregation
- Tempo - Distributed tracing
- 🌟 Star the repo to show your support ## 🤝 Contributing
- 💬 [Join our Discord →](https://discord.gg/8qfdJYfvpY)
We love contributions from our community! There are many ways to contribute:
- 🌟 Star the repository to show your support
- 🐛 [Report bugs](https://github.com/getprobo/probo/issues/new) - 🐛 [Report bugs](https://github.com/getprobo/probo/issues/new)
- 💡 [Request features](https://github.com/getprobo/probo/issues/new) - 💡 [Request features](https://github.com/getprobo/probo/issues/new)
- 📖 [Read the docs](coming soon) - 🔧 Submit pull requests
- 📖 Improve documentation
Please read our [Contributing Guide](CONTRIBUTING.md) before making a pull request.
## License ## 🌟 Why Probo?
This repository is entirely [MIT licensed](LICENSE). 1. **Accessible Compliance**: Traditional solutions are often behind expensive paywalls. We believe security measures should be accessible to all.
2. **Fresh Approach**: Built from scratch, learning from past issues to create a better compliance experience.
3. **Community-Driven**: As an open-source project, we believe the entire ecosystem should benefit from improvements and innovations.
## 📚 Documentation
- 📖 [Official Documentation](coming soon)
- 💬 [Discord Community](https://discord.gg/8qfdJYfvpY)
- 📝 [Blog](https://www.getprobo.com/blog)
## 🌐 Community & Support
- Join our [Discord community](https://discord.gg/8qfdJYfvpY)
- Follow us on [Twitter](https://twitter.com/getprobo)
- Connect on [LinkedIn](https://www.linkedin.com/company/getprobo)
- Visit our [website](https://www.getprobo.com)
## 📄 License
Probo is [MIT licensed](LICENSE).