Git Product home page Git Product logo

cv-frontend-vue's Introduction

The CircuitVerse logo

CircuitVerse Frontend Vue

CircuitVerse Frontend Vue is dedicated to enhancing the CircuitVerse platform in several key ways. Our primary focus is on decoupling the CircuitVerse Simulator from the backend, allowing it to function independently and with greater flexibility. Additionally, we're working to remove the reliance on jQueryUI, opting for cleaner and more contemporary code practices. To improve performance and code readability, we're transitioning from traditional DOM mutations to string-based manipulation. Furthermore, we're actively integrating internationalization features to ensure the platform is accessible to users worldwide. In summary, our repository aims to elevate the capabilities and user experience of CircuitVerse through targeted improvements and optimizations.

Community

We would love to hear from you! We communicate on Slack:

Slack

Installation

To set up the project on your local machine, follow these steps:

  1. Clone the repository to your local machine using the following command:
git clone https://github.com/CircuitVerse/cv-frontend-vue.git
  1. Navigate to the project directory:
cd cv-frontend-vue
  1. Install the project dependencies:
npm install
  1. Start the development server:
npm run dev

Setting up on cloud with Stackblitz

StackBlitz is an instant fullstack web IDE for the JavaScript ecosystem.

  1. Initiate the setup process by clicking on the following button:

Open in StackBlitz

  1. Once the setup is complete, a Preview URL will be displayed in the browser window. Append /simulatorvue/ to your URL to access the simulator.
https://<preview_url>/simulatorvue/

How to Use Vue Simulator with CircuitVerse Main Repo

To access the Vue Simulator from the CircuitVerse main repo dev server, you can follow one of the following methods:

Accessing Vue Simulator

  1. Start the CircuitVerse Main Repo dev server.
  2. go to the /vuesimulator path in the dev server.
  3. You would be accessing the Vue Simulator.

Setting Vue Simulator as Default

  1. Log in to the CircuitVerse dev server using the admin account:
  2. Once logged in, go to /flipper path and turn on vuesim feature flag site wide or for your user.
  3. After activation, you will be able to access the Vue Simulator site-wide in your dev server, also in /simulator path the Vue Simulator will be opening instead of the old simulator.

Code of Conduct

We follow the Code of Conduct of the CircuitVerse Community.

Contributing

See CONTRIBUTING.md for more information on contributing to CircuitVerse.

License

This project is licensed under the MIT License.

To Dos -

  1. Creating the mobile version of the vue simulator
  2. Testing and bug fixing
  3. Typescript integration & style Refactoring
  4. Creating the desktop application
  5. Removing JQuery

cv-frontend-vue's People

Contributors

devartstar avatar gr455 avatar arnabdaz avatar pulkit-30 avatar dependabot[bot] avatar tachyons avatar niladrix719 avatar disha1202 avatar prerna-0202 avatar kr-2003 avatar itshamdysalem avatar palaksharma23 avatar pavanjoshi914 avatar abstrekt avatar palashb01 avatar joshvarga avatar dhairyamajmudar avatar aryanndwi123 avatar ahmedibrahim404 avatar verovillar avatar pankaj-2503 avatar imgbot[bot] avatar zhongy1 avatar yarlord avatar wallento avatar sarthaknegigit avatar rajveer07 avatar tintin9999 avatar zopsss avatar sickaada avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.