https://github.com/openlabun/logisim_n
https://github.com/openlabun/logisim_n
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/openlabun/logisim_n
- Owner: openlabun
- License: mit
- Created: 2024-05-27T18:27:39.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-11T22:33:30.000Z (almost 2 years ago)
- Last Synced: 2025-08-11T09:33:12.360Z (10 months ago)
- Language: Dart
- Size: 316 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Logisim N
Development of a .circ file viewer in flutter
View Demo
·
Documentation
·
Report Bug
·
Request Feature
# :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
* [Summary](#summary)
* [why](#why)
* [Tech Stack](#space_invader-tech-stack)
* [Features](#dart-features)
- [Getting Started](#toolbox-getting-started)
* [Prerequisites](#bangbang-prerequisites)
* [Installation](#gear-installation)
* [Running Tests](#test_tube-running-tests)
* [Run Locally](#running-run-locally)
- [Usage](#eyes-usage)
- [Roadmap](#compass-roadmap)
- [Contributing](#wave-contributing)
- [Contact](#handshake-contact)
- [Acknowledgements](#gem-acknowledgements)
## :star2: About the Project
### Summary
This is a project for the Computer's Structure course, the goal is to create an app that serves a purpose to the Computer Science community.
Logisim N is a viewer for .circ files (file format of logisim) that tries to bring logisim (or at least the basics of it) to platforms like web with the use of flutter
As of now it just reads information from the file and uses it to draw the circuits
### Why
Logisim and Logisim evolution are java programs which means that you could run them almost anywhere, but, what about the web? or maybe you don't want to install java. Whatever reason prevents you from using the original program, Logisim N aims to be the tool you need.
We also hope that this project can serve as a base for other projects (like an online multi-user logisim or even just a way to easily share circuits) and as a way to learn things like xml, the flutter canvas, and whatever you need to have any feature you wish
### :space_invader: Tech Stack
Client
### :dart: Features
- Wires
- Tunnels
- A drawer
## :toolbox: Getting Started
### :bangbang: Prerequisites
This project uses Flutter, see how to install it [here](https://docs.flutter.dev/get-started/install)
Whit flutter installed and the repo cloned, don't forget to run
```bash
dart pub get
```
### :gear: Installation
Clone the project from github and build an executable for your target platform using
```bash
flutter build
```
### :test_tube: Running Tests
To run tests, run the following command
```bash
flutter test
```
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/adcerro/ec2_final_proyect.git
```
Go to the project directory
```bash
cd ec2_final_proyect
```
Install dependencies
```bash
dart pub get
```
Run the app
```bash
flutter run
```
## :eyes: Usage
Just run the app using
```shell
flutter run
```
## :compass: Roadmap
* [ ] Circuit Analizer
* [ ] Ability to edit files
## :wave: Contributing
Contributions are always welcome!
If you feel there's something to improve feel free to make a pull-request
## :handshake: Contact
Doriano Ojeda - [DorianoOjeda](https://github.com/DorianoOjeda)
Alan Florez - [adcerro](https://github.com/adcerro)
Project Link: [https://github.com/adcerro/ec2_final_proyect](https://github.com/adcerro/ec2_final_proyect)
## :gem: Acknowledgements
Many thanks to:
- [Awesome-readme-template](https://github.com/Louis3797/awesome-readme-template) for the template
- Professor [Augusto Salazar](https://github.com/augustosalazar/)