Skip to content

Commit

Permalink
Update docs for running locally
Browse files Browse the repository at this point in the history
  • Loading branch information
lwagner-getmomo committed Nov 13, 2023
1 parent e3e4d9a commit 29ad222
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ fctl ui

### Requirements
1. Make sure docker is installed on your machine.
2. Make sure Docker Compose is installed and available (it should be the case if you have chosen to install Docker via Docker Desktop); and
3. Make sure Git is also installed on your machine.
2. Ensure your docker daemon has at least 5GB uf usable RAM available. Otherwise you will run into random crashes.
3. Make sure Docker Compose is installed and available (it should be the case if you have chosen to install Docker via Docker Desktop); and
4. Make sure Git is also installed on your machine.


### Run the app
Expand All @@ -55,7 +56,7 @@ git clone https://github.com/formancehq/stack.git
cd stack
# Start the stack containers
docker-compose up
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.
Expand All @@ -66,6 +67,10 @@ User: [email protected]
Password: demo
```

### Caveats

- Authentication won't work with Safari.

## ☁️ Cloud Native Deployment

The Formance Stack is distributed as a collection of binaries, with optional packaging as Docker images and configuration support through command line options and environment variables. The recommended, standard way to deploy the collection of services is to a Kubernetes cluster through our Formance official Helm charts, which repository is available at [helm.formance.com](https://helm.formance.com/).
Expand Down

0 comments on commit 29ad222

Please sign in to comment.