andrew
e199380e64
Added detailed documentation files for code of conduct, contributing guidelines, core concepts, features, and project structure in the documentation/ directory. Updated README.md to reference new documentation, expand feature descriptions, and clarify setup instructions.
3.0 KiB
Nebula
A customizable and privacy-focused web browser built with Electron. Nebula is designed to be a lightweight, secure, and user-friendly browser with a focus on performance and privacy.
Features
- Privacy Control: Easily clear your browsing data, including history, cookies, and cache.
- Tab Management: Open new tabs, and manage them efficiently.
- Bookmarks: Save your favorite sites.
- History: Keeps track of your browsing and search history.
- Performance Monitoring: Built-in tools to monitor application performance.
- GPU Acceleration Control: Advanced settings to manage GPU acceleration and troubleshoot rendering issues.
- Cross-Platform: Runs on Windows, macOS, and Linux.
Learn more about Nebula's features.
Getting Started
Prerequisites
- Node.js installed.
Installation
- Clone the repository:
git clone https://github.com/Bobbybear007/NebulaBrowser.git - Navigate to the project directory:
cd NebulaBrowser - Install dependencies:
npm install
Running the Application
To start the browser, run the following command:
npm start
Building the Application
To build the application for your platform, run:
npm run dist
This will create a distributable file in the dist directory.
Project Structure
An overview of the project's structure. For a more detailed explanation, please see the Project Structure documentation.
main.js: The main entry point for the Electron application.renderer/: Contains all the front-end files.preload.js: Bridges the main and renderer processes.performance-monitor.js: Module for monitoring performance.gpu-config.js&gpu-fallback.js: Modules for managing GPU settings.assets/: Contains static assets.documentation/: Contains additional documentation.
Core Concepts
Nebula is built on several core concepts that are essential to understanding how it works. For a deeper dive, read the Core Concepts documentation.
- Main and Renderer Processes
- Inter-Process Communication (IPC)
- Performance and GPU Management
Contributing
Contributions are welcome! Please read our contributing guidelines to get started.
Technologies Used
- Electron
- HTML, CSS, JavaScript
License
This project is licensed under the MIT License. Read More