OrbitConfigrator

Development Setup

Prerequisites

• Node.js
• Yarn

Getting Started

1. Clone the repository:

git clone https://github.com/OrbitNavigator/OrbitConfigrator.git
cd OrbitConfigrator

2. Install Yarn:

If you don't have Yarn installed, you can install it globally using npm:

npm install -g yarn

3. Install dependencies:

yarn install

4. Run the development server:

yarn dev

Project Structure

The src folder contains all the code:

src
├── assets      # Contains static assets
├── main        # Contains main process code
├── renderer    # Contains React entry point and HTML file for the entry point
└── ui          # Contains the rest of the React app along with all the pages
vite.config.js  # Contains Vite configuration files
package.json    # Lists project dependencies and scripts
yarn.lock       # Ensures consistent installs across environments

Technologies Used

• Vite: For fast and optimized development.
• Electron: For building cross-platform desktop applications.
• React: For building user interfaces.
• Material-UI: For UI components.

License

This project is licensed under the GPL-3.0 License. See the LICENSE file for more details.