Skip to content

Commit

Permalink
Updated the Readme with setup information and pending tasks (#192)
Browse files Browse the repository at this point in the history
* Updated the readme with setup information
  • Loading branch information
disha1202 authored Oct 23, 2023
1 parent 7a816bf commit 068eadc
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
# GSoC'22 Project - [WIP]VueJS Simulator
# CircuitVerse Frontend Vue

## New Frontend Framework for Simulator UI.
- [Phase-1 Report](https://blog.circuitverse.org/posts/devjitchoudhury_gsoc22_phase1_report/)
- [Phase-2 Report](https://blog.circuitverse.org/posts/devjitchoudhury_gsoc22_phase2_report/)
## Installation
To set up the project on your local machine, follow these steps:

### Project Goals -
1. Replacing JqueryUI with a modern frontend framework.
2. Decoupling the Simulator from backend
3. Dividing into Components
4. State Management
5. Refactoring CSS
6. Internationalization using Vue-i18n
1. Clone the repository to your local machine using the following command:
```
git clone https://github.com/CircuitVerse/cv-frontend-vue.git
```
2. Navigate to the project directory:
```
cd cv-frontend-vue
```
3. Install the project dependencies:
```
npm install
```
4. Start the development server:
```
npm run dev
```


### To Dos -
1. **Vue Project Integration** into the Main Repository or finding a way for the simulators in two different repositories to work in sync.
2. **API Integration and Testing**
3. **Embed Feature** - Discuss and implement the embeding of circuits feature.
4. **Internationalization of Simulator** - Internationalization is already set up using Vue-i18n but progressive work needs to be done on it.
5. **Refactoring of Styles** - Refactor the global stylesheet to local stylesheets for individual components. There is also a scope of removing SASS using modern CSS features.
6. Few components - Verilog Module, Quick-Button, Testbench, and Timing-Diagram are yet to be converted to Vue.
7. With the removal of jQuery-UI, there is also a scope of removing the use of jQuery from the project.
## 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**

0 comments on commit 068eadc

Please sign in to comment.