linucks.io-client

The frotend repo for linucks.io ✨:sparkles:
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

Check out a live demo here.

linucks.io is a web application where you can test out a range of Linux distros before actually installing in on your system.

Linux is a popular kernel which is used mainly by developers because of the many benefits. Since there are a number of flavours of GNU/Linux, there are many options to choose from, which can be quite confusing for the user.

linucks.io is a one-stop solution for distro-hopping. With this application, we try the user by simulating a virtual environment of the distro of the user's choice. This is the repository for the frontend of the web-application, you can check out the backend on https://github.com/linucks-io/linucks.io-service/. Every time a user clicks on a distro, a request is sent to the backend, which allocates a docker image for that cluster and returns a SSL encrypted websocket URL for it, which can be accessed using noVNC on the browser.

Built With

• react
• react-bootstrap
• node-sass
• react-vnc
• react-router-dom
• react-dom

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm
• node

Installation

1. Clone the repo

git clone https://github.com/linucks-io/linucks.io-client.git

2. Install NPM packages

npm install

3. Add the necessary environment variables to a .env file.

echo "REACT_APP_BACKEND_URL=http://localhost:3001" > .env

Usage

1. Start react app

npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. 😄

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push -u origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ashikka Gupta 💻 📖

Fardeen Khan 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!