Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JDeffner committed Feb 6, 2024
1 parent 25ba03f commit c926087
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,17 @@ The following is a brief translation of the most important terms:
## Installation

1. Clone the repository to your local machine.
2. Run `npm install` to install JavaScript dependencies.
3. Initialize the database using the [databaseStructure.sql](databaseStructure.sql) file.
4. Change the [env](env) file name to `.env`.
5. Set up your database and update the `.env` file with your database credentials.
6. Update the `app.baseURL` variable in the `.env` file with the address you will use to access the application in your web browser.
7. Use whatever deployment method you prefer to deploy the application. See the [CodeIgniter documentation](https://codeigniter4.github.io/userguide/) for more information.
2. Initialize the database using the [databaseStructure.sql](databaseStructure.sql) file.
3. Change the [env](env) file name to `.env`.
4. Set up your database and update the `.env` file with your database credentials.
5. Update the `app.baseURL` variable in the `.env` file with the address you will use to access the application in your web browser.
6. Use whatever deployment method you prefer to deploy the application. See the [CodeIgniter documentation](https://codeigniter4.github.io/userguide/) for more information.


> [!TIP]
> `npm run scss`: Watches for changes in `main.scss` and compiles it to `main.css`.
### Optional: SCSS Compilation
1. Install node.js. You can download it from the [Official Website](https://nodejs.org/).
2. Run `npm install` to install JavaScript dependencies.
3. Use `npm run scss` to activate a file watcher that compiles any changes in `main.scss` to `main.css`.


## Usage
Expand All @@ -65,9 +66,9 @@ The application provides a user-friendly interface for managing Tasks inside a K

- **Spalten**: Each Board can have multiple Spalten. A Spalte represents a stage or a status of Tasks. CRUD operations for Spalten can be performed by clicking on the corresponding buttons in the Board details view.

- **Personen**: Personen are the users or team members in your project. They are assignable to Tasks and can be used to filter Tasks. When logged in, you can see your own tasks by clicking on the "Meine Aufgaben" button in the user dropdown menu in the top right corner of the application. You can create a new person by signing up with a new account. You can also update your details by clicking on the "Profil" button in the user dropdown menu. Personen also have a role, which can be "Administrator" or "Benutzer". Admins can create, update, and delete all data in the application, while Benutzers can only create, update, and delete the non-admin tables.
- **Personen**: Personen are the users or team members in your project. They are assignable to Tasks and can be used to filter Tasks. When logged in, you can see your own tasks by clicking on the "Meine Aufgaben" (TODO) button in the user dropdown menu in the top right corner of the application. You can create a new person by signing up with a new account. You can also update your details by clicking on the "Profil" button in the user dropdown menu. Personen also have a role, which can be "Administrator" or "Benutzer". Admins can create, update, and delete all data in the application, while Benutzers can only create, update, and delete the non-admin tables.

- **Taskarten**: Taskarten are the categories or types of Tasks in your project. You can add a new task type by clicking on the "Neu" button in the main menu.
- **Taskarten**: Taskarten are the categories or types of Tasks in your project. Admins can add a new task type by clicking on the "Neu" button in the Taskarten view.

## Screenshots

Expand Down Expand Up @@ -112,7 +113,8 @@ Admin is a user that is logged in and has admin rights.

## Project Structure

Since our project is based on the CodeIgniter framework, please refer to the [CodeIgniter application structure documentation](https://codeigniter4.github.io/userguide/concepts/structure.html) for more information about the general project structure.
> [!NOTE]
> Since our project is based on the CodeIgniter framework, please refer to the [CodeIgniter application structure documentation](https://codeigniter4.github.io/userguide/concepts/structure.html) for more information about the general project structure.
### Project Structure Overview

Expand Down Expand Up @@ -159,6 +161,6 @@ You can contact any of the contributors to this project through their respective

@JDeffner: [s4jodeff@uni-trier.de](mailto:s4jodeff@uni-trier.de)

@talina2: someEmail
@talina2: [s4tadara@uni-trier.de](mailto:s4tadara@uni-trier.de)

@s4kecast: someEmail
@s4kecast: [s4kecast@uni-trier.de](mailto:s4kecast@uni-trier.de)

0 comments on commit c926087

Please sign in to comment.