Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
flemzord committed Dec 6, 2023
1 parent f830c55 commit 1fbb072
Showing 1 changed file with 4 additions and 14 deletions.
18 changes: 4 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Formance is a highly modular developer platform to build and operate complex mon
- **Formance Ledger** - Programmable double-entry, immutable source of truth to record internal financial transactions and money movements
- **Formance Payments** - Unified API and data layer for payments processing
- **Formance Numscript** - DSL and virtual machine monetary computations and transactions modeling
- **Formance Control** - Web application dashboard for payments operators with unified views on all your data

## ⚡️ Getting started with Formance Cloud Sandbox

Expand Down Expand Up @@ -59,17 +58,7 @@ cd stack
docker compose up
```

You can now open your browser and go to http://localhost to connect to the application. The Stack's API is exposed at http://localhost/api.
You should use either use the pre-configured Github App (only for local testing) or the User/Password method to connect to the application, with the provisioned credentials:

```
User: [email protected]
Password: demo
```

### Caveats

- Authentication won't work with Safari.
The Stack's API is exposed at http://localhost/api.

## ☁️ Cloud Native Deployment

Expand All @@ -87,7 +76,8 @@ Formance is transitioning to a unified public facing monorepo (this one) that im

```
formancehq/stack/
|- services # Stack services imported as fixed-version submodules
|- apps # Stack services in OSS
|- ee # Stack services in EE Licence
|- docs # Exhaustive documentation deployed at docs.formance.com
|- config # Boilerplate configuration for stack dependencies
```
Expand All @@ -98,5 +88,5 @@ The Formance Stack is built on open-source, battle tested technologies including

- **PostgreSQL** - Main storage backend
- **Redis** - Caching and services instances syncing
- **Kafka/Redpanda** - Cross-services async communication
- **Kafka/NATS** - Cross-services async communication
- **Traefik** - Main HTTP gateway

0 comments on commit 1fbb072

Please sign in to comment.