From 16703dd8a4f8d22d1b0bea2a77bbebf56e5584d0 Mon Sep 17 00:00:00 2001 From: Liker4ik50 Date: Fri, 25 Aug 2023 09:10:27 +0600 Subject: [PATCH 1/2] [+] Added documentation --- README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 57 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c7f12a76..12770f5d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ technologies as little as possible. ## Project Structure: :dizzy: -[Effective-Tablet](tabletApp/README.md) +[Effective-Office-Tablet](tabletApp/README.md) An application for booking meeting rooms on a tablet. @@ -31,37 +31,80 @@ call the elevator remotely, after logging in through your google account ## Contributing :raised_hands: -Our project is open-source, so we welcome quality contributions! To make your contribution to the project efficient and easy to check out, you can familiarize yourself with the project's git flow and commit rules. If you want to solve an existing issue in the project, you can read the list in the issues tab in the repository. +Our project is open-source, so we welcome quality contributions! To make your contribution to the +project efficient and easy to check out, you can familiarize yourself with the project's git flow +and commit rules. If you want to solve an existing issue in the project, you can read the list in +the issues tab in the repository. ### Git flow -The best way to start helping with project development is to do a fork of our project, then make changes and make a pull-request to the to the appropriate branch to which your contribution relates. +The best way to start helping with project development is to do a fork of our project, then make +changes and make a pull-request to the to the appropriate branch to which your contribution relates. ### Rules on commit messages' content 1. Use the body to explain what and why vs. how - * Please make an extra effort to explain why changes are needed for every non-trivial modification. -2. If your pull request solves problem from the issues, please leave a link to it in the body of the pull request -3. If possible, try to avoid commits like *"Fixed after check "* and replace them with meaningful ones. -4. Keep the subject (the first line of the commit message) clean and readable. All additional information and directives for external tools -should be moved to the body of the message. + * Please make an extra effort to explain why changes are needed for every non-trivial + modification. +2. If your pull request solves problem from the issues, please leave a link to it in the body of the + pull request +3. If possible, try to avoid commits like *"Fixed after check "* and replace them with meaningful + ones. +4. Keep the subject (the first line of the commit message) clean and readable. All additional + information and directives for external tools + should be moved to the body of the message. ### Rules on commit messages' style/formatting 1. Before the subject line, add a symbol to show what your commit contains + * [+] - Addition -* [-] - Delete -* [~] - Fix, edit +* [-] - Delete +* [~] - Fix, edit + 2. Separate subject from body with a blank line 3. Do not capitalize the subject line 4. Do not end the subject line with a period 5. Use the imperative mood in the subject line +## Guidelines for starting up: :computer: + +In order to build all parts of project, you will need JDK and Android Studio. We are using this +versions: + +Android Studio Flamingo 2022.2.1 Patch 2 + +JDK: Version 11.0.15 + +## Running an application using gradle: :arrow_forward: + +1. Open the terminal and go to the root directory of the project. + +2. Run the ./gradlew assembleDebug command to assemble the project in debug mode. + +3. To run the application on an emulator or connected device, run the ./gradlew installDebug + command. + +4. If you want to run tests, run the command ./gradlew test. + +5. If you want to assemble the APK file for the release version, run the command ./gradlew + assembleRelease. + ## Authors: :writing_hand: -* [Artem Gruzdev](https://github.com/gull192) (Effective-TV) -* [Egor Parkomenko](https://github.com/1MPULSEONE) (Effective-TV) -* [Stanislav Radchenko](https://github.com/Radch-enko) (Office-Elevator, Effective-TV) -* [Maksim Mishenko](https://github.com/UserNameMax) (Effective-TV) +* [Artem Gruzdev](https://github.com/gull192) (Effective-TV,Effective-office) +* [Egor Parkomenko](https://github.com/1MPULSEONE) (Effective-office) +* [Stanislav Radchenko](https://github.com/Radch-enko) (Office-Elevator, Effective-TV, + Effective-office) +* [Maksim Mishenko](https://github.com/UserNameMax) (Effective-TV,Effective-office) +* [Margarita Ginjolia](https://github.com/MargaritaDj)(Effective-office) +* [Victor Konyshev](https://github.com/DireRaven-exe)(Effective-office) +* [Angelika Semenova](https://github.com/Liker4ik26)(Effective-office) +* [Olesia Shinkarenko](https://github.com/OlesiaShinkarenko)(Effective-office) +* [Danil Kiselev](https://github.com/kiselev-danil)(Effective-office) +* [Daniil Zavyalov](https://github.com/zavyalov-daniil)(Effective-office) +* [Roman Zyuzin](https://github.com/Roman194)(Effective-office) +* [Arseniy Savin](https://github.com/ayusavin)(Effective-office) +* [Vyacheslav Deich](https://github.com/plumsoftware)(Effective-office) -- GitLab From 95ce9e0bba8b6f81c3e6076ac2b972c51d8b83d3 Mon Sep 17 00:00:00 2001 From: Liker4ik50 Date: Tue, 29 Aug 2023 19:32:51 +0600 Subject: [PATCH 2/2] [~] Refactor documentation --- README.md | 40 ++++++++++++++++++++++++++++++---------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d9a6deb3..dcf6ae77 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,8 @@ technologies as little as possible. ## Project Structure: :dizzy: -Pre-requisite: [Notion](https://www.notion.so/effectiveband/613e964862f44c9faefefd7958697dd9?pvs=4). Note: due to the incompleteness of the database, placeholders may appear in applications +Pre-requisite: [Notion](https://www.notion.so/effectiveband/613e964862f44c9faefefd7958697dd9?pvs=4). +Note: due to the incompleteness of the database, placeholders may appear in applications [Effective-Tablet](tabletApp/README.md) @@ -33,29 +34,39 @@ call the elevator remotely, after logging in through your google account ## Contributing :raised_hands: -Our project is open-source, so we welcome quality contributions! To make your contribution to the project efficient and easy to check out, you can familiarize yourself with the project's git flow and commit rules. If you want to solve an existing issue in the project, you can read the list in the issues tab in the repository. +Our project is open-source, so we welcome quality contributions! To make your contribution to the +project efficient and easy to check out, you can familiarize yourself with the project's git flow +and commit rules. If you want to solve an existing issue in the project, you can read the list in +the issues tab in the repository. ### Git flow -The best way to start helping with project development is to do a fork of our project, then make changes and make a pull-request to the to the appropriate branch to which your contribution relates. +The best way to start helping with project development is to do a fork of our project, then make +changes and make a pull-request to the to the appropriate branch to which your contribution relates. ### Rules on commit messages' content 1. Use the body to explain what and why vs. how - * Please make an extra effort to explain why changes are needed for every non-trivial modification. -2. If your pull request solves problem from the issues, please leave a link to it in the body of the pull request -3. If possible, try to avoid commits like *"Fixed after check "* and replace them with meaningful ones. -4. Keep the subject (the first line of the commit message) clean and readable. All additional information and directives for external tools -should be moved to the body of the message. + * Please make an extra effort to explain why changes are needed for every non-trivial + modification. +2. If your pull request solves problem from the issues, please leave a link to it in the body of the + pull request +3. If possible, try to avoid commits like *"Fixed after check "* and replace them with meaningful + ones. +4. Keep the subject (the first line of the commit message) clean and readable. All additional + information and directives for external tools + should be moved to the body of the message. ### Rules on commit messages' style/formatting 1. Before the subject line, add a symbol to show what your commit contains + * [+] - Addition -* [-] - Delete -* [~] - Fix, edit +* [-] - Delete +* [~] - Fix, edit + 2. Separate subject from body with a blank line 3. Do not capitalize the subject line 4. Do not end the subject line with a period @@ -70,6 +81,15 @@ Android Studio Flamingo 2022.2.1 Patch 2 JDK: Version 11.0.15 +## How to run + +* You need Android Studio Flamingo 2022.2.1 Patch 2 +* [Read the backend documentation]() +* Add `apiKey=` in `local.properties` file, for + example `apiKey="72288ebc5b893cc92a76c701c6b700b6"` +* Run -> Run 'app' + + ## Running an application using gradle: :arrow_forward: 1. Open the terminal and go to the root directory of the project. -- GitLab