dzigr/form-template-finder

Fasapi project: form template finder

Form template finder

Fasapi project: form template finder

Stack:

• Python
• FastAPI
• MongoDB
• Docker
• Docker-compose

---

Start project with Docker

---

Note: Required Python & Poetry

1. Clone the repository

   git clone [email protected]:Dzigr/form-template-finder && cd form-template-finder
   

2. Initiate configuration with Makefile command

   make prepare
   

   This will create .env file with necessary variables, requirements file and build docker containers

3. Run application by

   make start
   

Without poetry

---

1. Create virtual environment

   python3 -m venv venv
   

2. Activate virtual environment

   source venv/bin/activate
   

3. Install requirements via pip

   pip install -r requirements.txt
   

4. Run docker-compose

   docker-compose up --build

---

Testing:

1. Run tests by

   make test
   

---

Usage:

View endpoints if needed

GET /api/ping/ - ping api service

POST /api/get_form/ - receive the query with data

Request example

  f_name1=value1&f_name2=value2

Response example

If form found in database return form template name:

  "FormName"

Otherwise return initial data with serialized fields:

{
  "f_name1": FIELD_TYPE,
  "f_name2": FIELD_TYPE
}

Finally:

1. Clear docker containers

   make clear