2._References - SofiAlfonso/Odissea GitHub Wiki
a) Sample input/output formats:
Input
- SQL request: A register form stored on SQL data base, here are going to be registered some basic information of the user. It contains name, origin language and country, email address, password. Also, there is going to be another request about the country the user is visiting.
- Text input: This is going to be the text the user wants to translate.
- 3Audio: This is going to be the audio the user wants to transcribe and translate.
- Jpg or Png file: This is going to be the image the user wants to scan and translate.
- Exchange input: this is going to be the amount of money user wants to change, it also will use some information of the SQL request, using origin and visited country data, and also API’s request information.
- API request: It contains all the information the AI’s API is going to give about suggestions, recommendations and other data like places and the value for some currency exchanges.
Output
- Text output: Is going to be the translated text the user will receive.
- Java Script response: It is a dropdown window that is going to appear on the user register or login, it will contain text like “Your account has been successfully created” or “Welcome to Odissea translator”.
- API’s responses: Are going to be the recommendations and suggestions the user will receive of AI. Those will appear on a dropdown interface the user is going to request through a button.
- Exchange response: is going to be an int answer that the view interface is going to send for the currency exchange request.
b) Background information
- The project will be managed on Django structure, using SQL as the data base service, integrating python libraries and AI APIs for translation and operations, HTML, CSS and Java Script for frontend. It will be kept on Git Hub. Also is important to know that the project is going to be deployed as an MVP, so all functionalities and requirements on SRS aren’t going to be obligatorily completed.
- Project requiremnts will be specified using the Mazo and Jaramillo template. But priorizing them using MoSCoW technique. The abreviations of requiremnts will be:
- FR for functional requirments
- PR for performance requiermnts
- UR for usability requierments
- DR for data base requirments
- CR for desing constraints
c) Problems software is going to solve
The software aims to address several common challenges faced by people in multilingual and multicultural settings. One primary problem is the language barrier that hinders effective communication between individuals who speak different languages. This barrier can cause misunderstandings and limit access to important information, whether in written, visual, or spoken form. The software also addresses the difficulty of understanding text in images, such as signs or documents, which may not be in the user's native language. Additionally, it solves the problem of interpreting spoken language in audio files, which can be particularly challenging without native language skills. For travelers or expatriates, the software helps by providing information about local points of interest, making it easier to navigate and enjoy new environments. Finally, the currency calculator feature addresses the challenge of converting prices between different currencies, a common issue when dealing with international transactions or budgeting while traveling. By tackling these problems, the software facilitates smoother communication, enhances accessibility, and provides useful tools for travel and everyday interactions.
d) Packaging instruction
For this software application the packing requirements are going to be consider but not like functional requierments. Initially the project will tackle the requirements needed to complete the MVP, and with that basics the project will be displayed, later if the project continue growing these practices and requirements will be needed. In that order:
- The packing process must have an environment configuration where all the dependences (libraries) need to be installed (all dependences are mentioned on Software interfaces headland).
- The packing process should have minification of CSS and Java Script files. Also, a compilation of python source code ('.pyc').
- The packing process must have a dependance incorporation.
- The packing process should have a probe execution.
- The packing process could have container packaging that contains the web application and the dependences.
- The packing process must integrate CI and CD tools, all managed by Git Hub.
- The Software will be displayed on cloud services.