Blocks

Visual Circuit

Contributors Forks Stargazers Issues License

Visual Circuit is an open source tool to develop robotic applications. It aims to make developing applications for ROS and Gazebo simple and user friendly by its intuitive block-based interface. Users have the ablity to drag and drop blocks to develop their logic. Users are also able to build completely custom blocks as well as edit code in the existing blocks, this makes Visual Circuit a robust and powerful tool to develop even complicated applications.

For more information visit our site VisualCircuit

Setup

Front-end

For more specific instructions check the frontend readme

  1. Clone the repository https://github.com/JdeRobot/VisualCircuit.git
  2. Change directory to frontend
  3. Run npm install
  4. Run npm start
  5. Open http://localhost:3000/ in browser.

Back-end

For more specific instructions check the backend readme

  1. Clone the repository https://github.com/JdeRobot/VisualCircuit.git
  2. Change directory to backend
  3. Create a Python3 virtual environment using venv. For eg. python -m venv .venv
  4. After activating the virtual environment, install the dependencies by running pip install -r requirements.txt
  5. Add .env file to the backend folder. And add the variables as defined in .env.template
  6. Create the static files to serve during execution by python manage.py collectstatic
  7. Start the server by running python manage.py runserver 8000

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For more info on how to design a block, refer to this link

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

1"""
2.. include:: ../README.md
3"""