First version of README.md file

Author: Christopher Harrison

README.md

@@ -1,38 +1,80 @@
-# create-svelte
+# Scenario : The Loved Mutt
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte);
+According to the American Society for the Prevention of Cruelty to Animals (ASPCA), animal shelters receive about 3 million dogs annually - about 6 dogs per minute! While euthanasia rates have dropped, over 500,000 dogs are euthanized because they could not be matched with their original owners or an adoptive family.
 
-## Creating a project
+Your team will aid a fictional adoption agency with deploying their website to the cloud. The application is designed to raise awareness of different dog breeds. A potential adopter can use the app to flip through pictures of various dogs and mark their favorites. Because each user will be marking various dogs as their favorites, they would like users to authenticate by using their Twitter accounts.
 
-If you're seeing this, you've probably already done this step. Congrats!
+The agency has already created the website using [Svelte](https://svelte.dev/) and [Svelte Kit](https://kit.svelte.dev/) for the front end, [Azure Functions](https://docs.microsoft.com/azure/azure-functions/functions-overview) and a [MongoDB API database](https://docs.mongodb.com/drivers/node/current/) for the back-end. They have provided documentation your team can review to gain an understanding of how it works, and run it locally for testing purposes.
 
-```bash
-# create a new project in the current directory
-npm init svelte@next
+## Resources
 
-# create a new project in my-app
-npm init svelte@next my-app
-```
+A series of resources will be provided to help your team determine the appropriate steps for completion. The resources provided should provide your team with enough information to achieve each goal. If you get stuck, you can always ask a mentor for additional help.
 
-> Note: the `@next` is temporary
+## Goals
 
-## Developing
+Your team will deploy the application to the cloud, enable authentication, and create and configure the database. To confirm your team has completed each goal, your team will use an automated validation tool. As each goal is met the next one will be revealed.
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+### Goal 0: Run the application locally
 
-```bash
-npm run dev
+The adoption agency's developers have provided full documentation on how to download and configure the application to run locally.
 
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
+### Goal 1: Deploy website to Azure Static Web Apps
 
-## Building
+[Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/overview) is a service which builds and deploys full stack web apps to Azure from a code repository. It provides hosting for static files (HTML, CSS, JavaScript, etc.) and server-side code through serverless Azure Functions. Azure Static Web Apps can host applications written with any front-end framework, including React, Angular, Vue.js and Svelte. Azure Functions can be used to access server resources such as databases or other APIs. A site deployed to Azure Static Web Apps automatically scales, and can even have custom domains.
 
-Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then:
+Success criteria:
 
-```bash
-npm run build
-```
+- The shelter's site has been successfully deployed to Azure Static Web Apps
+- You can open the index page on the newly created Azure Static Web App
 
-> You can preview the built app with `npm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.
+Once this has been completed, you will enter the site's URL into the validation tool.
+
+#### Deployment resources
+
+Your team might find these resources helpful:
+
+- [What is Azure Static Web Apps](https://docs.microsoft.com/en-us/azure/static-web-apps/overview)
+- [Quickstart: Building your first static site - Visual Studio Code](https://docs.microsoft.com/en-us/azure/static-web-apps/getting-started?tabs=vanilla-javascript#create-a-static-web-app)
+- [Quickstart: Create a static web app - Azure Portal](https://docs.microsoft.com/en-us/azure/static-web-apps/get-started-portal?tabs=vanilla-javascript#create-a-static-web-app)
+
+### Goal 2: Enable authentication
+
+Congratulations on deploying the application to Azure Static Web Apps! The shelter staff is thrilled to see their site on the internet!
+
+The application is designed to allow potential adopters identify their favorite dog breeds, so we need a way to identify users. The shelter staff happy with either GitHub or Twitter authentication. Your team will enable authentication for the application.
+
+Success criteria:
+
+- The application is updated and redeployed to enable authentication via either GitHub or Twitter
+- After the updated site is deployed, a user can authenticate using the selected provider by clicking the login link, and is then presented with the buttons to mark a dog as a favorite.
+
+#### Authentication resources
+
+Your team might find these resources helpful:
+
+- [Azure Static Web Apps - Login](https://docs.microsoft.com/en-us/azure/static-web-apps/authentication-authorization#login)
+- [Access user information in Azure Static Web Apps](https://docs.microsoft.com/en-us/azure/static-web-apps/user-information?tabs=javascript)
+- [Configure Azure Static Web Apps](https://docs.microsoft.com/en-us/azure/static-web-apps/configuration)
+- [Troubleshooting deployment and runtime errors](https://docs.microsoft.com/en-us/azure/static-web-apps/troubleshooting)
+
+### Goal 3: Create and configure a cloud-based database
+
+The shelter staff can't believe how close they are to seeing their prototype come to life! With authentication enabled, the last step is to enable a database.
+
+Because the application uses Mongo DB APIs to access the database, [Azure Cosmos DB](https://docs.microsoft.com/en-us/azure/cosmos-db/introduction) with the [API for MongoDB](https://docs.microsoft.com/en-us/azure/cosmos-db/introduction) is a great fit. With [Cosmos DB serverless](https://docs.microsoft.com/en-us/azure/cosmos-db/serverless) charges are based on usage. Your team will create a Cosmos DB account and configure the application to use your new Cosmos DB deployment.
+
+Note: The application will automatically create a database and collection to store data. Your team only needs to [create an Azure Cosmos DB account](https://docs.microsoft.com/en-us/azure/cosmos-db/create-cosmosdb-resources-portal#create-an-azure-cosmos-db-account).
+
+Success criteria:
+
+- Your team creates a Cosmos DB account
+- Clicking on the "Mark as favorite" button successfully saves an entry to the database and displays the next dog
+- The *favorites* page of the application lists the links to all dogs marked as favorites
+
+#### Database resources
+
+Your team might find these resources helpful:
+
+- [Get the MongoDB connection string by using the quick start](https://docs.microsoft.com/en-us/azure/cosmos-db/connect-mongodb-account#get-the-mongodb-connection-string-by-using-the-quick-start)
+- [Create an Azure Cosmos DB account](https://docs.microsoft.com/en-us/azure/cosmos-db/create-cosmosdb-resources-portal#create-an-azure-cosmos-db-account)
+- [Configure application settings for Azure Static Web Apps](https://docs.microsoft.com/en-us/azure/static-web-apps/application-settings)