Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
NizamLZ committed Sep 24, 2017
1 parent a1fb678 commit e961e84
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -29,31 +29,30 @@ Web & Messenger SDK

**Pre-requisites:**

1. Windows/Linux/Mac to host the Backend API
1. Windows/Linux/Mac to host the Platform API
2. Mongo DB
3. Windows PC with .NET Framework 4.5 to run Conversation Studio
4. Windows 10 PC to use Conversation Simulator (UWP App)

**Setup Platform:**

1. Download the pre-built binary from [releases](https://github.com/Kitsune-tools/ProjectANA/releases/latest) or Clone the repo. <br> You can also build from the docker image hosted on dockerhub. Click [here](https://hub.docker.com/r/projectana/platform/) to go to the dockerhub link.
1. Download the pre-built binary from [releases](https://github.com/Kitsune-tools/ProjectANA/releases/latest) or Clone the repo. <br> You can also build from the docker image hosted on dockerhub. Click [here](https://hub.docker.com/r/projectana/platform/) to see the instructions on Project ANA's dockerhub page.

2. You need to set up your mongodb instance first. You can either do that on your local machine or a server such as [MLab](https://mlab.com) . <br> Click [here](https://docs.mongodb.com/manual/tutorial/getting-started/) to know more about mongoDB such as installation and setting up a database. <br>
2. You need to set up your Mongo DB instance first. You can either do that on your local machine or get one from a Database-as-a-Service provider like [MLab](https://mlab.com). <br> Click [here](https://docs.mongodb.com/manual/installation) for instructions on installation and setup of Mongo DB.<br>

3. In ANA Conversation Platform project, open `appsettings-Sample.json` and edit `DatabaseConnectionSettings` section to match your Mongo DB details you had configured earlier.

3. In ANA Conversation Platform project, open `appsettings-Sample.json` and edit `DatabaseConnectionSettings` section to match your MongoDB details you had configured earlier.
4. Change collection names to new/empty collections.
5. Save and rename appsettings-Sample.json to appsettings.json.

3. Change Collection names to new/empty collections.
5. Save and Rename appsettings-Sample.json to appsettings.json.
6. To build the project, you need to have .NET Core 2.0 SDK installed in your system. Click [here](https://www.microsoft.com/net/download/core) to get the latest version. Note: .NET Core is cross platform and will work on windows, linux and mac.

6. To build the project, you need to have dotnet core version 2 installed in your system. Click [here](https://www.microsoft.com/net/download/core) to get the latest version. Note : Dotnet core is cross platform and will work on windows, linux and mac.
7. If you cloned the repository, follow the usual steps to restore, build and run a .NET Core project using `dotnet` cli or Visual Studio.

7. If you cloned the repository, follow the usual steps to restore, build and run a dotnet core project.
8. If you downloaded the pre built binaries, open the platform folder and find the `ANAConversationPlatform.dll` file. <br> Run `dotnet ANAConversationPlatform.dll` to start the Platform API server.

8. If you downloaded the pre built binaries, go inside the platform folder and find the `ANAConversationPlatform.dll` file. <br> Run `dotnet ANAConversationPlatform.dll` to execute.

9. Note down the base URL of your hosted project.
10. Optionally, Set the APIKey and APISecret in appsettings.json under BasicAuth section for security.
9. Note down the base URL of your hosted Platform API server (displayed in the console if started using the above cmd).
10. Optionally, set the `APIKey` and `APISecret` in `appsettings.json` under `BasicAuth` section for security.

**Setup Studio:**

Expand Down

0 comments on commit e961e84

Please sign in to comment.