Feature/219 update documentation

Backend/README.md

@@ -127,6 +127,20 @@
     python main.py
    ```
 
+## Format the code
+
+[Black](https://black.readthedocs.io/en/stable/) is a Python code formatter that automatically formats your code.
+
+- Format a single file:
+  ```bash
+  black your_file.py
+  ```
+
+- Format multiple files or a directory:
+  ```bash
+  black file1.py file2.py directory/
+  ```
+
 ## Useful Tools
 
 - IDE: VS Code, PyCharm

Frontend/README.md

@@ -54,6 +54,20 @@ Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.
 
 Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
 
+## Format the code
+
+[ESLint](https://eslint.org/) is a linting utility for JavaScript.
+
+- Lint a JavaScript file:
+  ```bash
+  npx eslint your_script.js
+  ```
+
+- For linting an entire directory:
+  ```bash
+  npx eslint .
+  ```
+
 ## Further help
 
 To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

README.md

@@ -1,66 +1,28 @@
-# Ticket-Chat-AI Project (AMOS WS 2023)
+# TalkTix
 
-## Setup
+Ticket-Chat-AI Project, AMOS WS 2023/24
 
-1. **Clone the Repository**:
+## What is TalkTix?
 
-   ```bash
-   git clone [email protected]:amosproj/amos2023ws01-ticket-chat-ai.git
-   ```
-
-## Code Standards and Linting
-
-Superlinter is configured to check the code standards for:
-
-- JavaScript
-- Python
-
-### Using Linters Locally
-
-Ensure code standards are met before pushing your changes using either VSCode Extensions or shell commands.
-
-#### Use Extensions in VSCode
-
-Install the following extensions in VSCode and follow the instructions on the installation site, or use the provided instructions:
-
-- Open the file you want to format.
-- For Python, use the Black extension (Alt+Shift+F).
-- For JavaScript, use the ESLint extension (Alt+Shift+F).
-
-#### Use Shell Commands
-
-Before running the commands, ensure that the required packages are installed by checking and installing from the `requirements.txt` and the `package.json` file.
+TalkTix empowers support teams to work more efficiently by eliminating short-term disruptions and thus enabling a
+focused way of working. It allows customers to easily report problems via free text or a simple voice message and
+automatically converts it into a support ticket without the support team actually having to create it manually.
 
-##### Python - Black Formatter
-
-[Black](https://black.readthedocs.io/en/stable/) is a Python code formatter that automatically formats your code.
-
-- **Usage:**
-   Format a single file:
-
-   ```bash
-   black your_file.py
-   ```
-
-   Format multiple files or a directory:
+## Project Installation
 
+1. Clone the repository
    ```bash
-   black file1.py file2.py directory/
+   git clone [email protected]:amosproj/amos2023ws01-ticket-chat-ai.git
    ```
 
-##### JavaScript - ESLint
-
-[ESLint](https://eslint.org/) is a linting utility for JavaScript.
+2. Follow the documentation:
+   [Build and Deploy Documentation](https://github.com/amosproj/amos2023ws01-ticket-chat-ai/wiki/Build---Deploy-Documentation)
 
-- **Usage:**
-   Lint a JavaScript file:
+## Software Usage
 
-   ```bash
-   npx eslint your_script.js
-   ```
+Follow the instructions:
+[User Documentation](https://github.com/amosproj/amos2023ws01-ticket-chat-ai/wiki/User-Documentation)
 
-   For linting an entire directory:
+## Our Documentation
 
-   ```bash
-   npx eslint .
-   ```
+You can find more information about our project in our [documentation](https://github.com/amosproj/amos2023ws01-ticket-chat-ai/wiki).