Skip to content

Commit f2ab5fb

Browse files
Rewrote README
1 parent 2ef1ae8 commit f2ab5fb

File tree

1 file changed

+40
-47
lines changed

1 file changed

+40
-47
lines changed

README.md

Lines changed: 40 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,42 @@
11
# Applitools Example: Selenium C# NUnit with the Ultrafast Grid
22

3-
TBD
4-
5-
--------------------
6-
7-
8-
9-
# Pre-requisites:
10-
11-
1. Visual Studio installed on your machine. Workload ".NET desktop development" should be installed in Visual Studio too (if no - add it with Visual Studio Installer)
12-
* [Install it from here](https://visualstudio.microsoft.com/downloads/)
13-
2. Chrome browser is installed on your machine.
14-
15-
* [Install Chrome browser](https://support.google.com/chrome/answer/95346?co=GENIE.Platform%3DDesktop&hl=en&oco=0)
16-
3. Chrome Webdriver is on your machine and is in the PATH. Here are some resources from the internet that'll help you.
17-
* [Download Chrome Webdriver](https://chromedriver.chromium.org/downloads)
18-
* https://splinter.readthedocs.io/en/0.1/setup-chrome.html
19-
* https://stackoverflow.com/questions/38081021/using-selenium-on-mac-chrome
20-
* https://www.youtube.com/watch?time_continue=182&v=dz59GsdvUF8
21-
4. Git is installed on your machine.
22-
23-
* [Install git](https://www.atlassian.com/git/tutorials/install-git)
24-
5. Restart your machine to implement updated environment variables (need for some OS).
25-
26-
# Steps to run this example
27-
28-
1. Git clone this repo
29-
30-
* `git clone https://github.com/applitools/tutorial-selenium-csharp-ultrafastgrid.git`
31-
32-
2. Get your API key to set it in code (or in the APPLITOOLS_API_KEY environment variable).
33-
34-
* You can get your API key by logging into Applitools > Person Icon > My API Key.
35-
36-
4. Navigate to folder `tutorial-selenium-csharp-ultrafastgrid` and double click the `ApplitoolsTutorial.sln`. This will open the project in Visual Studio
37-
38-
5. In Visual Studio open file UFGDemo.cs and change the `APPLITOOLS_API_KEY` with your own in code.
39-
Set your ApiKey in string 'config.SetApiKey("...") ' (or comment the string and set APPLITOOLS_API_KEY environment variable)
40-
41-
6. In Visual Studio open Package Manager Console (Tools > NuGet Package Manager > Package Manager Console) and enter command `dotnet restore` in the console. Command execution can take several minutes.
42-
43-
6. Build the solution (Build > Build Solution). It can take several minutes.
44-
45-
7. Run project (Debug > Start Without Debugging). Execution of project can take several minutes.
46-
47-
8. If needed, in case of some problems - update package Eyes.Selenium by NuGet Package Manager - Tools > NuGet Package Manager > Manage Nuget Packages for Solution, tab Updates. Select package for update (Eyes.Selenium), select needed version in right panel and tap Install
48-
49-
![](NuGet.png)
3+
This is the example project for the [Selenium C# NUnit tutorial](https://applitools.com/tutorials/quickstart/web/selenium/c-sharp).
4+
It shows how to start automating visual tests
5+
with [Applitools Eyes](https://applitools.com/platform/eyes/)
6+
and the [Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/)
7+
using [Selenium WebDriver](https://www.selenium.dev/) in Java.
8+
9+
It uses:
10+
11+
* [C#](https://learn.microsoft.com/en-us/dotnet/csharp/) as the programming language
12+
* [Selenium WebDriver](https://www.selenium.dev/) for browser automation
13+
* [Google Chrome](https://www.google.com/chrome/downloads/) as the local browser for testing
14+
* [NuGet](https://www.nuget.org/) for dependency management
15+
* [NUnit](https://nunit.org/) as the core test framework
16+
* [Applitools Eyes](https://applitools.com/platform/eyes/) for visual testing
17+
* [Applitools Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/) for cross-browser execution
18+
19+
To run this example project, you'll need:
20+
21+
1. An [Applitools account](https://auth.applitools.com/users/register), which you can register for free.
22+
2. A good C# editor, such as [Microsoft Visual Studio](https://visualstudio.microsoft.com/)
23+
or [Visual Studio Code](https://code.visualstudio.com/docs/languages/csharp).
24+
3. The [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) SDK (which may come bundled with Visual Studio).
25+
4. An up-to-date version of [Google Chrome](https://www.google.com/chrome/downloads/).
26+
5. A corresponding version of [ChromeDriver](https://chromedriver.chromium.org/downloads).
27+
28+
The main test case is [`AcmeBankTest.cs`](Applitools.Example.Tests/AcmeBankTest.cs).
29+
30+
To execute tests, set the `APPLITOOLS_API_KEY` environment variable
31+
to your [account's API key](https://applitools.com/tutorials/guides/getting-started/registering-an-account).
32+
33+
You can run the tests through Test Explorer in Visual Studio,
34+
or you can run tests from the command line using the following `dotnet` commands:
35+
36+
```
37+
dotnet build
38+
dotnet run
39+
```
40+
41+
**For full instructions on running this project, take our
42+
[Selenium C# NUnit tutorial](https://applitools.com/tutorials/quickstart/web/selenium/c-sharp)!**

0 commit comments

Comments
 (0)