chore: docs

NickNaskida · Oct 4, 2023 · f00506a · f00506a
1 parent c7baf6c
commit f00506a
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 3 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023] [Nikoloz Naskidashvili]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,6 +1,12 @@
 # Venue Booking Mini Application
 
 ### Description
+This is a mini application that allows users to book venues.
+
+Video Demonstration - [demo]()
+
+### Note
+This file contains only the setup of this application. For a detailed explanation of my code see [TUTORIAL.md](TUTORIAL.md)
 
 ### Tech Stack & Libraries
 
@@ -54,7 +60,22 @@
 
 ### Setup
 
-#### Ngrok
+#### Cloning project
+
+1. Clone project
+    ```
+    git clone https://github.com/NickNaskida/TeleVenue.git
+    ```
+2. Navigate to project directory
+    ```
+    cd TeleVenue
+    ```
+   
+#### Telegram Bot Setup
+
+#### Ngrok Setup
+Telegram mini app requires a public url (https) to work. We will use `ngrok` to expose our local server to the internet.
+
 1. Download ngrok from [here](https://ngrok.com/download)
 2. Edit ngrok configuration file 
 ```
@@ -81,9 +102,12 @@ ngrok config check
 ```
 ngrok start --all
 ```
-7. Copy the `forwarding` url for `front` and `back` and ...
+7. Copy the `forwarding` url for `front` and `back` 
 
 ### Common Errors and Troubleshooting
 
 ### Other notes
-- To enable inspect for web app, press settings icon 5 times and turn on `Debug Web App`
+- To enable inspect for web app, press settings icon 5 times and turn on `Debug Web App`
+
+### License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
diff --git a/TUTORIAL.md b/TUTORIAL.md
@@ -0,0 +1,15 @@
+# Mini App Development Tutorial
+
+### Note
+This file contains a detailed explanation of the code in this project. For a quick setup of this application see [README.md](README.md)
+
+### Client side
+
+### Backend side
+
+### Common Errors and Troubleshooting
+
+### Other notes
+- To enable inspect for web app, press settings icon 5 times and turn on `Debug Web App`
+
+### Other tutorials that cover this tech