matyas-zavora/aplha-2

Php project that shortens text file based on shortage table

Alpha 2

Description

This is the second alpha project. It is a website that allows the user to upload a text file and then shorten it (or make it longer) based on user's criteria. The processing is done by a backend written in . The website is written in , and .

Hey, listen! The shortening is also case-insensitive.

This project was made by Matyáš Závora (me)

Grade(s):

Percent score	70%
Czech grade	2
Configurability and universality	85%
Architecture and design patterns	40%
Usability and program control	63%
Correctness and efficiency	83%
Testing and error handling	66%
Documentation and code readability	100%

Prerequisites

• ( or any other web server)
• 7.4 (or higher)
• A web browser
• A text file to shorten
• (Optional) Access to the internet ( for )
  • Note: website is fully functional without , but it won't look as good as it is supposed to.

Installation

Windows

1. Open or any other web server
2. Clone this repository into the htdocs folder of
3. Start (Apache should be enough) (default port is 80)
4. Open localhost[:port]/alpha2 in your browser

Linux

1. Clone this repository into /var/www/html
2. Start Apache (default port is 80)
3. Open localhost[:port]/alpha2 in your browser

If you get a permission error, run sudo chmod -R 777 /var/www/html/alpha2 and sudo chown -R www-data:www-data /var/www/html/alpha2. This will give the web server full access to the folder.

Usage

1. Open the website in your browser (see Installation)
2. Click on the Choose file button
3. Select a text file
4. Fill out The mighty table of shortages
5. (Optional) Change the name of the output file
6. Click on the Shorten! button
7. Wait for the website to process the file
8. Select a location to save the processed file
9. Click on the Save button

Example

Input

Lorem ipsum dolor sit amet.

The mighty table of shortages

Shortage	Replacement
Lorem	L
ipsum	i
dolor	d
sit	s
amet	a

Output

L i d s a.

TODO

Meta

• Write README.md
• Turn assignment in on Moodle in time
• Make sure everything works
• Make sure everything is documented

Frontend

• Change assignment button placement
• Make file input accept only text files
• Change style of file input
• Make submit button appear only when file is uploaded
• Change button style (add more space in between)
• Implement text input for name of output file

Backend

• Make submit button work
• Make file input work
• Make text input work (name of output file)
• Output processed file (website starts downloading it)
  • Make processing case-insensitive
  • Fix file deletion from server
• Add unit tests
• Add "show logs" button
  • Routes to a page that shows logs