Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 51 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,59 @@
# React + TypeScript + Vite
# Webuntu - Where our bugs have more character than your typical '404' page.
# Webuntu - Waiting builds character! Even our code takes breaks. 🐢
![Logo](https://www.youtube.com/watch?v=dQw4w9WgXcQ)

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
## Overview

Currently, two official plugins are available:
This project aims to create a web-based user interface that simulates the look and feel of a real Ubuntu desktop environment. Users can interact with the website as if they were using a virtual machine running Ubuntu. Except the Terminal.

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
## Features

## Expanding the ESLint configuration
- **Desktop Environment**: Mimics the Ubuntu desktop environment to provide a familiar user experience.
- **Applications**: Pre-installed applications commonly found in Ubuntu.
- **Customization**: Users can customize their virtual desktop settings.
- **!Responsive Design**: The website isn't designed to be responsive and compatible with various devices.

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
## Getting Started

- Configure the top-level `parserOptions` property like this:
### Prerequisites

```js
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
```
- Node.js
- NPM (Node Package Manager)

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
### Installation

1. Clone the repository:

```bash
git clone https://github.com/your-username/ubuntu-like-website.git
```
2. Install Dependencies
```bash
npm install
```
3. Run the Dev-Server
```bash
npm run dev
```
### Usage
1. Open your web browser and navigate to http://localhost:5173/.
2. Interact with the virtual desktop environment.
3. Customize settings and explore pre-installed applications.

## Contributing

We welcome contributions! If you'd like to contribute to this project, please follow the guidelines in CONTRIBUTING.md.

## License

This project is licensed under the ***BaNaNa*** License.
> https://www.youtube.com/watch?v=sJZ1G0e5bWU

## Acknowledgments

> Inspired by the Ubuntu desktop environment.
> Built with Vite, React and Node.js.

## Contact

For any questions or feedback, please contact [your.email@example.com].