/API-Builder

Restful API endpoint creation for a user

Primary LanguagePythonMIT LicenseMIT

👩‍💻 API Builder 👩‍💻

SWC team 🧑‍🔧

This is a team project for the subject Tools of Software @ELTE.

Quick overview🤳🏼

API Builder is a tool that help you generate APIs from your data!

How does this work?

  • You register for an account to our API Builder tool website.
  • Then you will be able to create a project.
  • A project is your space to create your API.
  • Then you can upload your data or inject the data manually through the UI.
  • Finally you will have a generated URL where you can apply requests on this URL and modify the data inside this project.
  • The history of changes over the project will be tracked an you can go back to the data at any state of time!

      • How to run 🏃🏼‍♀️

      Currently we don't have CD system so there is no factories, but you still can run the docker.

      So you can run the program as follows:

      Clone the project

      git clone git@github.com:Aldokimi/API-Builder.git

      Build the project's API image

      cd backend
docker build -t api-builder-api:latest .

      Build the project's UI image

      cd fronted/API-Builder-UI
docker build -t api-builder-gui:latest .

      Build the whole application

      docker-compose up