Skip to content

Latest commit

 

History

History
163 lines (104 loc) · 7.22 KB

README.md

File metadata and controls

163 lines (104 loc) · 7.22 KB
Raw

Azure Remix Stack

A Remix Stacks template for deploying to Azure. This is based off the Indie Stack template, but adapted for Azure.

npx create-remix --template aaronpowell/azure-remix-stack

What's in the stack

Note: you will need an Azure account to deploy this.

Development

  • Initial setup: If you just generated this project, this step has been done for you.

    npm run setup

  • Start dev server:

    npm run dev

This starts your app in development mode, rebuilding assets on file changes.

The database seed script creates a new user with some data you can use to get started:

  • Email: aaron.powell@microsoft.com
  • Password: AzureRocks!

Deployment

Quick testing

You can quickly spin up the infrastructure on Azure using azd.

  1. Initialize your Azure environment (enter a name for the environment, select a subscription and region to deploy to):

    azd init

  2. Provision the resources in Azure

    azd provision

  3. Deploy from local

    azd deploy

Deploy with GitHub Actions or Azure Pipelines

Once you're ready, you can get azd to scaffold up a GitHub Action workflow (or Azure Pipelines definition).

  1. Scaffold the workflow

    azd pipeline config

  2. Commit the generated workflow and push

Relevant code:

This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.

Deployment

This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.

Before running a deployment, you'll need to provision the Azure Container Registry and Azure WebApp for Conitainers instances, as well as an Azure SQL database.

Note: Ensure that the Azure SQL database connection is configured in app settings as DATABASE_URL for the app to access it.

GitHub Actions

We use GitHub Actions for continuous integration and deployment. Anything that gets into the main branch will be deployed to production after running tests/build/etc. Anything in the dev branch will be deployed to staging.

Environment Variables

GitHub Actions will need the following secret variables to run:

  • DATABASE_URL: Connection info for a database to run the Cypress tests again
  • AZURE_RESGISTRY_URL: URL of the Azure Container Registry
  • AZURE_REGISTRY_USERNAME: Username to authenticate against Azure Container Registry
  • AZURE_REGISTRY_PASSWORD: Password to authenticate against Azure Container Registry
  • AZURE_CLIENT_ID: Client ID to authenticate against
  • AZURE_TENANT_ID: Tenant ID to autnenticate against
  • AZURE_SUBSCRIPTION_ID: Subscription that the web app belongs to
  • AZURE_WEBAPP_NAME: Name of the app to deploy into

Testing

Cypress

We use Cypress for our End-to-End tests in this project. You'll find those in the cypress directory. As you make changes, add to an existing file or create a new file in the cypress/e2e directory to test your changes.

We use @testing-library/cypress for selecting elements on the page semantically.

To run these tests in development, run npm run test:e2e:dev which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above.

We have a utility for testing authenticated features without having to go through the login flow:

cy.login();
// you are now logged in as a new user

We also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file:

afterEach(() => {
  cy.cleanupUser();
});

That way, we can keep your connected db clean and keep your tests isolated from one another.

Vitest

For lower level tests of utilities and individual components, we use vitest. We have DOM-specific assertion helpers via @testing-library/jest-dom.

Type Checking

This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run npm run typecheck.

Linting

This project uses ESLint for linting. That is configured in .eslintrc.js.

Formatting

We use Prettier for auto-formatting in this project. It's recommended to install an editor plugin (like the VSCode Prettier plugin) to get auto-formatting on save. There's also a npm run format script you can run to format all files in the project.

License

The template is licensed under MIT, but the license file will be removed as you scaffold the template, so make sure you license your repo appropriately.