KinematicsSolverWebAPI

KinematicsSolverWebAPI is API of the backend of the web application (based on project KinematicsSolverWebApp ») that allows users to create multi-users robotic projects to calculate Forward and Inverse Kinematics. Application allows user to fill information about themselves in profile page and see stats on dashboard.
Explore the docs »

Table of Contents

1. Getting Started
   • Installation
   • Technologies
2. About the project
3. License
4. Contact

Getting Started

To run this project, clone repo, run docker desktop and run server.

Installation

1. Clone the repo

   $ git clone https://github.com/Szezi/KinematicsSolverWebAPI

2. Run Docker Desktop

3. Build docker image

   $ docker-compose build

4. Migrate

   $ docker-compose run web python manage.py migrate

5. Create superuser

   $ docker-compose run web python manage.py createsuperuser

6. Run server

   $ docker-compose up 

Technologies

• Python
• Django
• Django REST framework
• PostgreSQL
• Docker

(back to top)

About The Project

KinematicsSolverWebAPI is a API of the web application that allows users to create multi-users robotic projects and calculations. Application allows user to fill information about themselves in profile page and see stats on dashboard.
To see different pages of application user need to be logged in.

API Overview

First API page allows user to move to Accounts and Robot Overview.

Accounts Overview

API overview page display to user possible url paths for different accounts API Views.

Robotic Overview

API overview page display to user possible url paths for different robotic API Views.

Accounts

User during registration add avatar, description and basic information about user. AbstractUser was used. Several API views was created to manage users account like: -register -login -change password -user details view -user update view

Dashboard

Dashboard API View allows user to keep track with basic information about users projects. It allows user to get basic stats: numer of projects, numer of calculated Forward and Inverse Kinematics and detail of the last created robot.

Robotic Project

API allows user to create new project. During creation user can select admins and members of the project. List of all projects user is member of can be accessed by ProjectListAPIView.

ProjectDetailAPIView allows user to get details of the project and list of robots linked to the project Only administrator can edit or delete project using ProjectUpdateAPIView and ProjectDestroyAPIView.

Robotic Arm

User can create new robotic arm for calculations and add them to selected project using RobotCreateAPIView. During creation user fill information about robot and add notes. List of all robots that robots projects user is member of can be accessed by using RobotListAPIView.

API allows user to receive all detail of selected robot and ik&fk calculations if created. Only member of the project can edit or delete robot using RobotUpdateAPIView and RobotDestroyAPIView.

Forward Kinematics

FkDetailAPIView allows user to receive calculations details and update them. User can calculate forward kinematics giving thetas values.

Inverse Kinematics

FkDetailAPIView allows user to receive calculations details and update them.
User can calculate inverse kinematics giving xyz values.

(back to top)

License

Distributed under the GPL-3.0 license. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/Szezi/KinematicsSolverWebAPI

(back to top)