Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sajeetharan/scifidevconf2024


https://github.com/sajeetharan/scifidevconf2024

Last synced: 14 days ago
JSON representation

Awesome Lists containing this project

README 

        
# Scifi Dev Conf App With Data API Builder



A sample JAMstack application of Static Web Apps with Database Connections backed by Data API Builder for an Angular Application with Azure Cosmos DB (NOSQL API) as a database



## Features



This project uses the Data API Builder integrated with Static Web Apps to provide the following functionality:



- CRUD access to database contents with GraphQL

- Built-in authorization with Static Web Apps authentication



## Getting Started



### Prerequisites



1. An Azure Cosmos DB Account (NOSQL API) with collection(ipl2023) created[Cosmos DB NoSQL API database account](https://learn.microsoft.com/azure/cosmos-db/sql/create-cosmosdb-resources-portal#create-an-azure-cosmos-db-account)

2. Once the container is created, we can import the sample data from `experts.json` which is placed in the ['sample-data'](./sample-data/experts.json) to the experts collection by using the add new item option (Make sure you add one by one item) in the Azure Data Explorer.

   ![Cosmos DB Add New Document](./media/insert-new-document.png)

3. Latest NodeJS and NPM installed

4. [Visual Studio Code](https://code.visualstudio.com/)

5. [An Azure Static Web App resource](https://learn.microsoft.com/en-us/azure/static-web-apps/get-started-portal)



### Installation



1. Clone this repository

2. Navigate to `root` directory & open with VSCode

3. Set the `DATABASE_CONNECTION_STRING` environment variable to your connection string in your terminal/cmd/powershell. Alternatively, paste your database connection string directly into `swa-db-connections/staticwebapp.database.config.json` (_not recommended_) (ensure that you remove this secret from your source code before pushing to GitHub/remote repository)

4. Run `swa start http://localhost:4200 -db ./swa-db-connections` to kick start the Static web app with

   database connections

5. In a new terminal, Run `npm i && ng serve` will install needed npm packages and run your Angular app



`--data-api-location swa-db-connections` indicates to the SWA CLI that your database connections configurations are in the `swa-db-connections` folder



Alternatively, you can start all these projects manually an make use of SWA CLI's other args



You can now use your experts Demo Application. It supports authorization, such that anyone logged in with SWA CLI's authentication emulation with the `anonymous` role will have `CRUD` access. See the configurations detailed in `staticwebapp.database.config.json`



### To deploy



1. Commit all your changes and push to your repository.

   - You do not need to change your configuration file's `data-source` object, since this will be overwritten by your Static Web App resource when you connect a database.

   - (If you have paste your connection string directly in your configuration file, ensure that you remove it to avoid making your database connection string public)

2. Go to your Static Web App resource in the portal. Go to the Database connection tab.

3. Ensure that your database is ready for connection. It should be configured to accept network requests from Azure services. If you plan to use managed identity as a connection type, ensure that you've configured the managed identity within your database.

4. Link your database to your default environment. Select your database & enter the credentials.



### Troubleshooting



- Ensure your Cosmos DB Account is configured to accept network requests

- Ensure that your configuration files have been placed in your repository and included in your build process.

- Ensure that your managed identity has been configured within your database.