Skip to content

Commit

Permalink
hmmmm
Browse files Browse the repository at this point in the history
  • Loading branch information
Dae Sanghwi committed Nov 22, 2024
1 parent b425c98 commit f4f6869
Showing 1 changed file with 22 additions and 141 deletions.
163 changes: 22 additions & 141 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@
[![License](https://img.shields.io/badge/License-YUOSL-purple)](LICENSE)
[![Platform](https://img.shields.io/badge/Platform-Linux-green.svg)](https://www.linux.org)

## Documentation

**All documentation has been moved to our website!**

Visit [yeonsphere.github.io/nexus](https://yeonsphere.github.io/nexus.html) for:
- Installation Guide
- User Manual
- Developer Documentation
- Extension API
- Contributing Guidelines

## Important Update

We have shifted our focus to a new implementation to better serve our users. This README contains information about the current, actively developed version of Nexus Browser.
Expand All @@ -17,153 +28,23 @@ This browser is still in development and is not currently supported by official

We appreciate your understanding and patience as we continue to improve the Nexus Browser.

## Discord Invite Link

https://discord.gg/uYJr9ZWQF4

## Overview

Nexus Browser is a modern web browser built with Flutter and Elixir. It allows users to browse the internet and access various websites. The browser includes features such as tab management, bookmarking, downloads, ad blocking, customizable settings, and a basic extension system.

(For inquiries about the specifics of ad blocking, please contact @daedaevibin)
(The ad blocking feature in Nexus Browser is designed in compliance with US federal laws. YeonSphere, its works, or members cannot be held liable for any conflicts with website-specific or company-specific terms of service regarding ad blocking. This browser and its features are not intended for use by Google, its affiliates, or any companies that restrict ad blocking, and cannot be considered in violation of their terms of service.)

## Structure

The repository is structured as follows:

- `lib`: Contains the source code for the Nexus Browser implementation.
- `frontend`: Contains the Flutter frontend code.
- `backend`: Contains the Elixir backend code.
- `assets`: Contains various resource files used by the browser.
- [README.md](README.md): This file, containing project information.

## Building

To build Nexus Browser:

1. Ensure you have Flutter (SDK >=3.0.0) and Elixir (~> 1.15) installed.
2. Clone the repository: `git clone https://github.com/YeonSphere/Nexus.git`
3. Navigate to the project directory: `cd Nexus`

### Frontend Setup
1. Navigate to the frontend directory: `cd frontend`
2. Install Flutter dependencies: `flutter pub get`
3. Build the project: `flutter build`

### Backend Setup
1. Navigate to the backend directory: `cd backend`
2. Install Elixir dependencies: `mix deps.get`
3. Start the Phoenix server: `mix phx.server`

## Current Dependencies

### Backend (Elixir)
- Phoenix Framework v1.7.10
- Phoenix PubSub v2.1
- Jason v1.4
- Plug Cowboy v2.6
- CORS Plug v3.0
- HTTPoison v2.2
- Poison v5.0

### Frontend (Flutter)
- Flutter SDK >=3.0.0
- window_manager v0.3.7
- url_launcher v6.2.2
- cupertino_icons v1.0.6
- http v1.1.2
- provider v6.1.1
- shared_preferences v2.2.2
- flutter_bloc v8.1.3
- path_provider v2.1.1
- sqflite v2.3.0

## Contributing and Usage

Contributions are welcome! Please feel free to submit a Pull Request.

However, please note that redistribution, commercial use, or creating derivative works based on this software require explicit permission from @daedaevibin. To obtain permission, contact @daedaevibin via:
## Ad Blocking Notice

- GitHub: @daedaevibin
- Phone: +1 (208) 464-4061 (preferred method for faster response)
- Email: daedaevibin@naver.com
The ad blocking feature in Nexus Browser is designed in compliance with US federal laws. YeonSphere, its works, or members cannot be held liable for any conflicts with website-specific or company-specific terms of service regarding ad blocking. This browser and its features are not intended for use by Google, its affiliates, or any companies that restrict ad blocking, and cannot be considered in violation of their terms of service.

When contacting, please state your name and reason for use to avoid being mistaken for spam.
## Quick Links

## Technology Stack

- Flutter: For cross-platform mobile and web application development
- Elixir: For the backend server
- Dart: For type-safe programming in Flutter
- Webview: For rendering web content
- HTTPoison: For making HTTP requests

## Features

The current implementation of Nexus Browser includes:

- Tab management
- Bookmarking
- Downloads manager
- Ad blocking (compliant with US federal laws)
- Customizable settings
- Basic extension system
- Cross-platform support (Windows, macOS, Linux)
- Developer tools

## Development Setup

1. Clone the repository: `git clone https://github.com/YeonSphere/Nexus.git`
2. Install dependencies for the frontend: `cd frontend && flutter pub get`
3. Install dependencies for the backend: `cd backend && mix deps.get`
4. Start the development server for the backend: `mix phx.server`
5. For the frontend, run: `flutter run`

## Contributing

We welcome contributions! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for details on our code of conduct and the process for submitting pull requests.
- [Website & Documentation](https://yeonsphere.github.io/nexus.html)
- [Discord Community](https://discord.gg/uYJr9ZWQF4)
- [Issue Tracker](https://github.com/YeonSphere/Nexus/issues)
- [License](LICENSE)

## License

This project is licensed under the YeonSphere Universal Open Source License (YUOSL). Key points:
- Free for use up to $50,000 in annual revenue
- 5% revenue share required above $50,000
- 30-day response window for inquiries
- Contact @daedaevibin for commercial licensing
- See the [LICENSE](LICENSE) file for full details
This project is licensed under the YeonSphere Universal Open Source License (YUOSL). See the [LICENSE](LICENSE) file for details.

## Contact

- Primary Contact: Jeremy Matlock (@daedaevibin)
- Discord: https://discord.gg/uYJr9ZWQF4
- Email: daedaevibin@naver.com

## Acknowledgments

- All contributors and supporters of the Nexus Browser project

## Security

We take security seriously. If you discover a security vulnerability within Nexus Browser, please send an email to security@nexusbrowser.com. All security vulnerabilities will be promptly addressed.

## Roadmap

Our future plans for Nexus Browser include:

1. Improved performance and stability
2. Enhanced privacy features
3. More customization options
4. Expanded extension capabilities
5. Integration with decentralized technologies

Stay tuned for updates!

## Community

Join our growing community:

- Join our Discord server: [https://discord.gg/uYJr9ZWQF4](https://discord.gg/uYJr9ZWQF4)
- Check out our blog for the latest news and updates: [https://YeonSphere.github.io/blog/](https://YeonSphere.github.io/blog/)

We value your feedback and suggestions. Together, we can make Nexus Browser the best browsing experience possible!
- Discord: [Join our community](https://discord.gg/uYJr9ZWQF4)
- GitHub Issues: [Report bugs or request features](https://github.com/YeonSphere/Nexus/issues)
- Email: daedaevibin@naver.com

0 comments on commit f4f6869

Please sign in to comment.