# Sample Real-Time App (Svelte)
> The following sample app tests Keploy integration capabilities with realtime subscriptions such as SSE
## Introduction
🪄 Dive into the world of realtime subscriptions and see how seamlessly Keploy integrates with SSE and MongoDB Buckle up, it's gonna be a fun ride! 🎢
## 🛠️ Platform-Specific Requirements for Keploy
Below is a table summarizing the tools needed for both native and Docker installations of Keploy on macOS, Windows, and
Linux:
| Operating System | Without Docker | Docker Installation | Prerequisites |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **macOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](/server/install/) | - Docker Desktop version must be 4.25.2 or above - Ensure that Lima is installed on your machine if you prefer to try without Docker. |
| **Windows** | [Guide](/keploy-explained/windows-wsl.md) | [Guide](/server/install/) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install` - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 - Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide |
| **Linux** | | | Linux kernel 5.15 or higher |
On macOS and Windows, additional tools are required for Keploy due to the lack of native eBPF support.
# Installation Overview
By default, this guide installs the **Keploy Community Edition**. The install command below is the same for everyone. Once you sign in, Keploy detects your plan and enables Community Edition features by default, or Pro / Enterprise features if your account has access to them.
## Quick Installation Using CLI
Let's get started by setting up the Keploy alias with this command:
```bash
curl --silent -O -L https://keploy.io/install.sh && source install.sh
```
:::info
By default, this command installs the **Keploy Community Edition**. Your plan (Community, Pro, or Enterprise) is determined after you log in.
:::
You should see something like this:
```bash
▓██▓▄
▓▓▓▓██▓█▓▄
████████▓▒
▀▓▓███▄ ▄▄ ▄ ▌
▄▌▌▓▓████▄ ██ ▓█▀ ▄▌▀▄ ▓▓▌▄ ▓█ ▄▌▓▓▌▄ ▌▌ ▓
▓█████████▌▓▓ ██▓█▄ ▓█▄▓▓ ▐█▌ ██ ▓█ █▌ ██ █▌ █▓
▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌ ██ █▓ ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀ █▓█
▓▌ ▐█▌ █▌
▓
Keploy CLI
Available Commands:
example Example to record and test via keploy
config --generate generate the keploy configuration file
record record the keploy testcases from the API calls
test run the recorded testcases and execute assertions
update Update Keploy
Flags:
--debug Run in debug mode
-h, --help help for keploy
-v, --version version for keploy
Use "keploy [command] --help" for more information about a command.
```
🎉 Wohoo! You are all set to use Keploy.
## Other Installation Methods
Install using Docker
**_Downloading and running Keploy in Docker_**
#### On macOS/Windows
Note : Keploy is not supported natively on MacOS and Windows, so you can follow the below method to run with docker
1. Open up a terminal window.
2. Create a bridge network in Docker using the following docker network create command:
```bash
docker network create keploy-network
```
2. Install Keploy
```shell
curl --silent -O -L https://keploy.io/install.sh && source install.sh
```
#### Examples:
**Record:**
```bash
keploy record -c "docker run -p : --name --network keploy-network " --container-name "" --buildDelay 60
```
**Test:**
```bash
keploy test --c "docker run -p : --name --network keploy-network " --delay 10
```
Install Natively
**_Downloading and running Keploy in Native_**
**Prequisites:**
- Linux Kernel version 5.15 or higher
- Run `uname -a` to verify the system architecture.
- In case of Windows, use WSL with Ubuntu 20.04 LTS or higher.
Downloading and running Keploy On WSL/Linux AMD
#### On WSL/Linux AMD
1. Open the terminal Session.
2. Run the following command to download and install Keploy:
```bash
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz --overwrite -C /tmp
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
```
#### On WSL/Linux ARM
1. Open the terminal Session
2. Run the following command to download and install Keploy:
```bash
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy
```
> Note: Keploy is not supported on MacOS natively.
**_Setting up the Docker Desktop for WSL 2_**
1. Install Docker Desktop for Windows from [here](https://docs.docker.com/desktop/windows/install/).
When developing on Windows with Docker Desktop and WSL 2, it's crucial to configure Docker Desktop to allow WSL 2 distributions to access the Docker daemon. This setup enables seamless integration between your Windows environment, WSL 2 Linux distros, and Docker.
By default, Docker Desktop may not be configured to work with all WSL 2 distros out of the box. Proper configuration ensures that you can run Docker commands from within your WSL 2 environment, allowing for a more native Linux development experience while leveraging the power of Windows.
> This setup is essential for Keploy to function correctly in a WSL 2 environment, as it needs to interact with the Docker daemon to manage containers and networks effectively.
> For detailed instructions on how to configure `Docker Desktop` for WSL 2, please refer to the [official Docker documentation](https://docs.docker.com/desktop/wsl/).
## Installation 📥
Ways you can run this sample application.
- [Using Docker container for MongoDB and running application locally](#installation-setup)
## Installation Setup
#### Server
```bash
git clone https://github.com/keploy/samples-go.git && cd samples-go/sse-svelte
go mod download
```
### Start MongoDB Instance
Using the docker-compose file we will start our mongodb instance:-
```bash
# Start Postgres
docker-compose up mongo
```
### Build Application Binary
Now, we will create the binary of our application:-
```bash
go build -cover
```
Once we have our applicaiton binary ready, we will start the application with keploy to start capturing the testcases.
## Capture the test cases
```bash
sudo -E keploy record "./sse-mongo"
```
### Start the UI
We will capture our test from the UI written in Svelte.js
```bash
cd svelte-app && npm install && npm run dev
```
Now let's click on `GetTime` button to trigger the event. We would notice that keploy will capture those calls : -
## Run the Testcases
Now let's run the test mode :-
```shell
keploy test -c "./sse-mongo" --delay 10 --goCoverage
```
Output should look like : -
So no need to setup fake database/apis like Postgres or write mocks for them. Keploy automatically mocks them and, **The application thinks it's talking to MongoDb 😄**. And with just few clicks we were able to get 42% code coverage of our go backend application.