putuwaw/etf-nfa repository overview

⁠ETF-NFA

ETF-NFA is a website based string checker using Extended Transition Function for Nondeterministic Finite Automata.

⁠Features💡

By using ETF-NFA you can:

• Checks whether a string is accepted by the language or not.
• Get details of the ETF process for NFA.
• Get transition diagram images of each language.

⁠Technology 👨‍💻

ETF-NFA is created using:

• Python⁠ - Python as the main programming language.
• Flask⁠ - Flask is a web framework for Python, based on the Werkzeug toolkit.
• Bootstrap⁠ - Bootstrap is a front-end framework that allows for the creation of easy and responsive web layouts.
• Heroku⁠ - Heroku is a platform as a service (PaaS) that we use to deploy our apps.
• Docker⁠ - Docker is a platform for developing, shipping, and running our applications.

⁠Structure 📂

ETF-NFA
├── .github
├── docs
├── handlers
├── modules
├── static
│   ├── images
│   ├── scripts
│   └── styles
├── templates
├── tests
├── .gitignore
├── LICENSE
├── Dockerfile
├── Procfile
├── README.md
├── app.py
└── requirements.txt

• .github⁠ is a folder that used to place Github related stuff, like PR template, issue template, and CI pipeline.
• docs⁠ contain documentation of this app.
• handlers⁠ contain handler to handling HTTP request methods, especially POST method.
• modules⁠ contain the main modules for each language.
• static⁠ contain static files like images, CSS, and JavaScript files.
• templates⁠ contain the file that will be rendered for display in the browser.
• tests⁠ contain unit test to make sure the main module work properly.
• .gitignore⁠ is a file to exclude some folders like venv.
• LICENSE⁠ is a file that contains the license we use in this app.
• Dockerfile⁠ is a file that contains all the commands to build an image.
• Procfile⁠ is a file that specifies the commands that are executed by an Heroku app on startup.
• README.md⁠ is the file you are reading now.
• app.py⁠ is the main file of this app.
• requirements.txt⁠ is a file that contains a list of dependencies used in this app.

⁠Requirements 📦

• Python 3.10 or later
• Docker 20.10.17 or later

⁠Installation 🛠️

• Install Docker
• Pull the image from Docker Hub⁠:

docker pull putuwaw/etf-nfa

• Run the downloaded image:

docker run -p 8000:8000 putuwaw/etf-nfa

• Open web browser and visit:

localhost:8000

⁠Contributors ✨

Putu Widyantara⁠

Kevin Moses⁠

Antonius Ata⁠

Yoga Laksana⁠