Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Piyush-linux authored Jun 3, 2024
1 parent 18657aa commit 48e1482
Showing 1 changed file with 49 additions and 19 deletions.
68 changes: 49 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,48 @@

![](/docs/ss.png)

# Astra OS
- An Web Linux WM
- UI : https://i.pinimg.com/736x/87/3b/b7/873bb76870c5831b3db734cfbf7cf165.jpg
- Color: https://colorhunt.co/palette/0c2d57fc6736ffb0b0efecec
- popup: https://lusaxweb.github.io/vuesax/components/popup.html
- TechStack: Nuxt, Tailwind, ShepherdJS,
# Astra OS 🔮

## Setup
### About
"Welcome to Astra OS, a next-generation web UI inspired by the power and versatility of Linux distributions. Experience seamless navigation, sleek design, and unparalleled functionality. With Astra OS, embark on a journey of innovation, where every click opens doors to new horizons. Whether you're a seasoned tech enthusiast or a curious explorer, Astra OS is your gateway to a world of limitless possibilities. Elevate your online experience and discover the future of web interfaces with Astra OS."

- OS : Linux
- Node : 18.x
- bun : 1.2.x
### Inpiration
- __UI Inspiration__ : https://i.pinimg.com/736x/87/3b/b7/873bb76870c5831b3db734cfbf7cf165.jpg
- __Color Pallete__ : https://colorhunt.co/palette/0c2d57fc6736ffb0b0efecec
- __TechStack__: Nuxt, Tailwind, ShepherdJS,

## Setup 💻

### Prerequisites
- __OS__ : Linux
- __Node__ : 18.x
- __bun__ : 1.2.x

### Getting Started
1. Clone the repo
```sh
git clone https://github.com/Piyush-linux/astraos.git
```
2. Install the Dependencies
```sh
bun install
```
3. Dev run
```sh
bun run dev
```
4. Build the Repo and Preview
```sh
bun run build
bun run preview
```

## UI
## Technology 🚀
- __NuxtJS__ : Nuxt.js is a Vue.js framework that streamlines the development process
- __Tailwind CSS__ : Tailwind CSS is a utility-first CSS framework that simplifies the process of building responsive and customizable user interfaces.
- __Shepherd.js__ : Shepherd.js is a lightweight JavaScript library for guiding users through your web application with interactive step-by-step tours.

- Colors : https://colorhunt.co/palette/0c2d57fc6736ffb0b0efecec

## Roadmap
## Roadmap 🗺️

__v1__
- [X] UI: Profile
Expand All @@ -47,8 +64,21 @@ __v2__
- [ ] Event: Bluetooth btn
- [ ] Event: Application btn

### IDEAS
2. (Retro Theme) : Linux ...
- portfolio: https://www.dreamstime.com/stock-illustration-retro-document-style-one-page-website-design-flat-image49154910#res26615551
- OS : https://dribbble.com/shots/17648244-Thanks-I-guess
- Linux WM : https://i.pinimg.com/736x/87/3b/b7/873bb76870c5831b3db734cfbf7cf165.jpg

## Contributing 🌱

We welcome contributions from the community! If you'd like to contribute to this project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request to the main repository's develop branch.

Please ensure your code adheres to our coding standards and includes appropriate tests.

### Contact 📬

If you have any questions or suggestions, feel free to reach out to us at Twitter/X @piyush_linux

Thank you for contributing to OpenZone! Let's build something great together.
Meow Meow !!

0 comments on commit 48e1482

Please sign in to comment.