Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

updated readme broken links #7

Merged
merged 6 commits into from
Feb 16, 2022
Merged

updated readme broken links #7

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a5ef2db
updated link
nevilm-lt Feb 16, 2022
d49c7b4
updated readmefile
nevilm-lt Feb 16, 2022
acba0c9
updated badges
nevilm-lt Feb 16, 2022
3e38c90
added minimum system requirements
nevilm-lt Feb 16, 2022
e3dc120
added minimum requirement
nevilm-lt Feb 16, 2022
ab5d8f8
minor url fix
nevilm-lt Feb 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@
</p>

<p align="center">
<a href="https://github.com/LambdaTest/test-at-scale/tree/master/licenses"><img src="https://img.shields.io/badge/license-PolyForm--Shield--1.0.0-lightgrey"></img></a> <a href="https://discord.gg/Wyf8srhf6K"><img src="https://img.shields.io/badge/Discord-5865F2"></img></a>
<a href="https://github.com/LambdaTest/test-at-scale/tree/master/licenses"><img src="https://img.shields.io/badge/license-PolyForm--Shield--1.0.0-lightgrey"></img></a>
<a><img src="https://github.com/lambdatest/test-at-scale/actions/workflows/main.yml/badge.svg"></img></a>
<a><img src="https://github.com/lambdatest/test-at-scale/actions/workflows/golangci-lint.yml/badge.svg"></img></a>
<a><img src="https://github.com/lambdatest/test-at-scale/actions/workflows/stale.yml/badge.svg"></img></a>
<a href="https://discord.gg/Wyf8srhf6K"><img src="https://img.shields.io/badge/Discord-5865F2"></img></a>

</p>

## **Status**

![Go report card & Test coverage](https://github.com/lambdatest/test-at-scale/actions/workflows/main.yml/badge.svg) ![Linting](https://github.com/lambdatest/test-at-scale/actions/workflows/golangci-lint.yml/badge.svg) ![close issues and PR](https://github.com/lambdatest/test-at-scale/actions/workflows/stale.yml/badge.svg)


## Table of contents
- 🚀 [Getting Started](#getting-started)
- 💡 [Tutorials](#tutorials)
Expand Down Expand Up @@ -53,20 +52,23 @@ cd ~/test-at-scale
curl https://raw.githubusercontent.com/LambdaTest/test-at-scale/master/.sample.synapse.json -o .synapse.json
```

- This file will be used to store certain parameters such as **Lambdatest Secret Key**, **Git Token**, **Repository Secrets**, **Container Registry** etc that will be required in configuring test-at-scale on your local/self-hosted environment. You can learn more about the configuration options [here](tas-self-hosted-configuration#parameters).
- This file will be used to store certain parameters such as **Lambdatest Secret Key**, **Git Token**, **Repository Secrets**, **Container Registry** etc that will be required in configuring test-at-scale on your local/self-hosted environment. You can learn more about the configuration options [here](https://www.lambdatest.com/support/docs/tas-self-hosted-configuration#parameters).


### Step 3 - Installation

<details>
<details id="docker">
<summary>Docker</summary>

### Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Docker-Compose](https://docs.docker.com/compose/install/) (Recommended)
- **Minimum System Requirement**
- CPU: 2 cores
- RAM: 4 GB

### Docker Compose
- Create a configuration file using [these steps](tas-self-hosted-installation#creating-a-configuration-file).
- Create a configuration file using [these steps](https://www.lambdatest.com/support/docs/tas-self-hosted-installation/#step-2--creating-a-configuration-file).
- Download and run the docker compose file using the following command.
```bash
curl -L https://raw.githubusercontent.com/LambdaTest/test-at-scale/master/docker-compose.yml -o docker-compose.yml
Expand All @@ -79,7 +81,7 @@ docker-compose up -d
To get up and running quickly, you can use the following instructions to setup Test at Scale on Self hosted environment without docker-compose.


- Create a configuration file using [these steps](https://www.lambdatest.com/support/docs/tas-self-hosted-installation#step-2--creating-a-configuration-file).
- Create a configuration file using [these steps](https://www.lambdatest.com/support/docs/tas-self-hosted-installation/#step-2--creating-a-configuration-file).
- Execute the following command to run Test at Scale docker container

```bash
Expand All @@ -94,6 +96,16 @@ docker run —name synapse —-restart always \
```
> **WARNING:** We strongly recommend to use docker-compose while Test at Scale on Self hosted environment.

</details>
<br>

#### **Supported Platforms:**

<details>
<summary>Local Machine</summary>

Setup using [docker](#docker).

</details>

<details>
Expand Down