cicada-notifications-app v1.2.3

Cicada

RFQ Notification Popups

Introduction

Cicada unlocks boundless liquidity in Mexican Government bonds. Built with Electron, this application leverages the latest web and desktop application technologies to provide an unparalleled user experience.

Features

• Real-time Notifications: Stay updated with the latest movements in Mexican Government bonds.
• User-friendly Interface: Easy to navigate interface, designed for a seamless user experience.
• Cross-Platform Support: Available for Windows, macOS, and Linux.

Installation

To use RFQ Notification Popups, you can download the latest version from the releases page.

Usage

To launch RFQ Notification Popups, simply open the application from your desktop or start menu. The intuitive interface allows you to start responding RFQ orders immediately.

Development Setup

To set up a development environment for RFQ Notification Popups:

1. Clone the repository:

   git clone https://github.com/Cicada-Technologies-Inc/cicada-electron-notifications-v2
   cd cicada-electron-notifications-v2

2. Install dependencies with Yarn:

   yarn

   or

   make install

3. • Set up the environment in the .env file:

   VITE_ENVIRONMENT=staging

4. Start the application in development mode:

   yarn start

   or

   make start

Building and Packaging

To package RFQ Notification Popups for distribution:

• Make distributable:

  yarn make

  or

  make dist

Usage Script Mac/Linux

Running the Script

To run the script, execute the following command with one of the specified environments as an argument:

./update_env.sh <environment>

Replace with one of the following options:

1. production
2. dev
3. staging
4. demo
5. local

For example, to set the environment to "staging", you would run:

./update_env.sh staging

Before running the script, ensure that the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables are set in your terminal session:

export AWS_ACCESS_KEY_ID="your_access_key_id"
export AWS_SECRET_ACCESS_KEY="your_secret_access_key"

Environment Variables

List and describe any important environment variables that users need to know about.

AWS_ACCESS_KEY_ID: Your AWS access key ID.
AWS_SECRET_ACCESS_KEY: Your AWS secret access key.

Usage Script Windows

To use this PowerShell script on Windows:

1. Open PowerShell and navigate to the directory containing the script.
2. Run the script with the desired environment as an argument:

   .\update_env.ps1 -Environment staging

Before running the script, ensure that the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables are set in your PowerShell session:

$Env:AWS_ACCESS_KEY_ID="your_access_key_id"
$Env:AWS_SECRET_ACCESS_KEY="your_secret_access_key"