diff --git a/README.md b/README.md index 7cc8304..ccf219b 100644 --- a/README.md +++ b/README.md @@ -23,27 +23,32 @@ services.AddUmbraco(_env, _config) ### Sample site - Get it up and running. -The sample sites requires .NET 6 and NPM. The site has demo content, so that once it's up and running, you can have a look around. -There is a sample site for both Umbraco 9 and Umbraco 10. The demo sites uses the same frontend client, which is located in the Umbraco 9 sample site folder. If you wish to run the v10 sample site, then just follow the steps below for the client. +The sample site requires .NET 6 and NPM. There is a sample site for both Umbraco v9 and Umbraco v10. +The sample site share the same frontend client, which is located in the Umbraco v10 sample site folder. +The sample site has demo content, so once it's up and running, you can have a look around. + + If you wish to setup and run, then just follow the steps below: 1. Start by cloning the repository. -2. Setting up our frontend. +2. Setting up the frontend. - 1. Navigate to `samples/UmbracoV9/client` (also if intend to run the v10 sample - see above) + 1. Navigate to `samples/UmbracoV10/client` (also if intend to run the v9 sample - see above) 2. Run `npm install` via a command prompt 3. Run `npm run serve` via a command prompt 3. Spinning up the site. 1. Navigate to `samples/UmbracoV9` or `samples/UmbracoV10`, depending on whether you want to sample v9 or v10. - 2. In the appsettings, enter your `DatasetId` and `ApiKey` for Relewise (you can find those at https://my.relewise.com under `Settings -> Developer Settings`). There is a commented out section, where you can enter it (Remember to comment the section back in!). Alternatively you can create a `local.settings.json` file and add the section in there. - 3. Run `dotnet run` via a command prompt. - 4. Umbraco will throw some error in the console - just ignore those - 5. `dotnet run` open a new browser tab, continue the setup in that new tab. + 2. Run `dotnet run` via a command prompt. + 3. Access the website from your browser 4. Installing Umbraco - When visiting the site for the first time, you are asked to configure Umbraco. Just follow the instructions. 5. Publish the content of the site. The site comes with content already created. You just need to login and publish the content +## Resources + +Find more information on the Umbraco Marketplace: https://umbraco.com/marketplace/relewise/ + ## Contributing Pull requests are always welcome. diff --git a/Relewise.Integrations.Umbraco.sln b/Relewise.Integrations.Umbraco.sln index 17ec736..7c76164 100644 --- a/Relewise.Integrations.Umbraco.sln +++ b/Relewise.Integrations.Umbraco.sln @@ -9,7 +9,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Samples", "Samples", "{41BF EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Relewise.UmbracoV9", "samples\UmbracoV9\Relewise.UmbracoV9.csproj", "{53D4C642-13D2-4F61-A941-2CA19526315A}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Git", "Git", "{828EE997-7585-459E-9D6E-626A3A83A3A1}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".git", ".git", "{828EE997-7585-459E-9D6E-626A3A83A3A1}" ProjectSection(SolutionItems) = preProject .gitignore = .gitignore README.md = README.md