Azion Console Kit 💻🚀🧡

Introduction 📖

Azion Console Kit is a front-end development kit made in Vue/Vite with the PrimeVue and Tailwind framework that allows you to run a customized Azion Console interface.

This project was developed by Azion, an edge computing platform that allows you to build and run applications anywhere. You'll find our products and services on it. 🚀

Getting Started 🔛

Requirements

Before you begin, ensure that you have the following:

• Node.js version 18 or later
• Yarn package manager

If you are not a JS developer and don't want to install yarn and node, you can use Docker:

alias yarn="docker run -it --rm -p 5173:5173 -v $HOME:/root -v $PWD:/usr/src/app -w /usr/src/app node:18 yarn"

Setup

1. Clone the repository and navigate to the root folder.

   git clone [email protected]:aziontech/azion-console-kit.git
   cd azion-console-kit

2. Install dependencies and start the project:

    $ yarn install
    $ yarn dev --host

The console becomes available at http://localhost:5173.

Configuration 💻

Setting the API environment (STAGE/PRODUCTION)

By default, Azion Console Kit uses the STAGE stack to connect with Azion APIs. To point your application to the PRODUCTION stack, add the following command in the .env file:

VITE_ENVIRONMENT = 'production'
// or to use Azion stage APIs
VITE_ENVIRONMENT = 'stage'

# another option if you do not want to use .env file
export VITE_ENVIRONMENT='production'
# or to use Azion stage APIs
export VITE_ENVIRONMENT='stage'

Running on the Edge 🚀

Azion Console Kit can run natively on Azion's edge using Azion CLI. Follow these steps:

1. Download the Azion CLI here and configure your personal token:

   azion -t ${PERSONAL_TOKEN}

2. Link project to an Azion edge application.

   azion link

   Choose the Vue preset.

3. Publish your project to create the application's domain:

   azion deploy

   This step is responsible for deploying your base project and creating a domain. This domain will be later on used to implement the configuration rules.

   💡 Tip: You can use the --config-dir argument to separate project environments. The CLI will use the reference to store application states. If you don't need two environments, don't pass the argument and it will use the original reference.

After a few seconds, access your project on the domain provided by the CLI.

Using Stripe Keys with Environment Variables

This project utilizes Stripe for payment processing, and it requires environment-specific API keys for proper configuration. To set up your environment with the correct Stripe keys, follow these instructions:

Environment Variables You need to set the following environment variables in your .env file or environment configuration:

• VITE_STRIPE_TOKEN_DEV: This is your Stripe API key for the development environment. It's typically used for local testing during development.

• VITE_STRIPE_TOKEN_STAGE: This is your Stripe API key for the staging environment. It's typically used for testing purposes before deploying to production.

• VITE_STRIPE_TOKEN_PROD: This is your Stripe API key for the production environment. It should only be used in your live application where real transactions occur.

Example .env File

Create a .env file at the root of your project and add the following lines, replacing the placeholder keys with your actual Stripe API keys:

VITE_STRIPE_TOKEN_DEV=pk_test_yourDevApiKeyHere
VITE_STRIPE_TOKEN_STAGE=pk_test_yourStageApiKeyHere
VITE_STRIPE_TOKEN_PROD=pk_live_yourProductionApiKeyHere

Features 🧩

Azion Console Kit includes the following features:

• Multi-tenancy: build your Azion Console by consuming endpoints from the Azion Public API.
• Customizable UI: configure theme tokens or generate them automatically via the Builder, giving the UI the look and feel you need.
• Simple structure: layered separation of blocks, components, and services for easy route building.

Contributions 🤝

Before beginning development or contributing to the project, familiarize yourself with the following resources:

• Contributor Guide (CONTRIBUTING.md): learn how to contribute to this project and the processes to do so.
• Development Guide (DEVELOPER.md): learn how to set up your development environment.
• Security Guide (SECURITY.md): learn about the secutiry validaton process.
• Contributor Covenant Code of Conduct (CODE_OF_CONDUCT): understand how to maintain the quality and integrity of the project.

Community 💬

You can find us on:

• Discord
• X
• LinkedIn
• YouTube

Move to the Edge! 🌎➡️🧡