@bananacool467/authtics-host 0.1.4 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Authtics Host
2
2
 
3
- Version 0.1.4
3
+ Version 0.1.6
4
4
  License: MIT
5
5
 
6
6
  Authtics Host is a framework inspired by Next.js. Authtics Host supports SSR (Server-Side Rendering) and uses esbuild.
@@ -11,11 +11,11 @@ Authtics Host is a framework inspired by Next.js. Authtics Host supports SSR (Se
11
11
 
12
12
  To get **Authtics Host** use:
13
13
  ```bash
14
- npm i @bananacool467/authtics-host@beta
14
+ npm i @bananacool467/authtics-host@latest
15
15
  ```
16
16
  or
17
17
  ```bash
18
- npm install @bananacool467/authtics-host@beta
18
+ npm install @bananacool467/authtics-host@latest
19
19
  ```
20
20
 
21
21
  You can have auto paging enabled, auto paging checks your given directory for HTML and TSX files and then adds them to route. If auto filing is enabled, auto filing will check your given directory for files and add them accessible to route.
@@ -155,15 +155,33 @@ The Developer Panel is what you could use to help you debug your code. The Devel
155
155
  **Route** — Shows information about the current route.
156
156
  **Webpage Info** — Shows information about the website/webpage.
157
157
  **Network** — Shows the current ping and shows sent fetches from the client and shows received from the server after fetching.
158
- **Client Info** — Shows information about your client's User Agent, OS and FPS.
159
- **About Host** — Shows the current version of Authtics Host.
158
+ **Client Info** — Shows information about your client's User Agent, OS **(Operating System)** and FPS **(Frames Per Second)**.
159
+ **About Host** — Shows the current version of *Authtics Host*.
160
160
  **Server Info** — Shows how much heap was used and how much CPU was used on the server and how much requests there were and how much users are currently on the site and how long the site has been up.
161
161
 
162
162
  The information the Developer Panel shows outside of the tabs is just your **DAT** (Developer Access Token).
163
163
 
164
164
  **(NOTE: If you do not set DAT restriction (Which will be explained on how to set it up in the next section), you will only get access to the Console and Network tabs)**
165
165
 
166
- ## Developer Panel Notes And Warnings And DAT (Developer Access Token)
166
+ The Developer Panel also have remote buttons:
167
+
168
+ **Restart App** — Restarts the website.
169
+ **Shut Down App** — Stops the website.
170
+ **Pause Users**/**Resume Users** — Stops users from reaching a site and they will get a JSON error message like this when visiting if Pause Users is on:
171
+ ```json
172
+ { "message": "unhandled request" }
173
+ ```
174
+ unless you click **Resume Users**, to show a **Paused Screen** when `autoPaging` is **off** you have to go to your `authtics_host.config.ts` and then add:
175
+ ```typescript
176
+ "hasPausedRoute": true
177
+ ```
178
+ and then create a file like `paused.tsx` and then inside `App.tsx`, import `Paused` from `@bananacool467/authtics-host` and then import your `Paused` page and then add in `RouteMap`:
179
+ ```tsx
180
+ <Paused page={paused} />
181
+ ```
182
+ and if your using `autoPaging` then you just create a file named `_paused.tsx`.
183
+
184
+ ## Developer Panel Notes And DAT (Developer Access Token)
167
185
 
168
186
  A DAT (Developer Access Token) is your token that is used to access the Developer Panel.
169
187
 
@@ -185,7 +203,7 @@ But if you have multiple DATs, then use:
185
203
 
186
204
  There isn't any limit of DATs you can add.
187
205
 
188
- **(Warning: Make sure `devMode` is set to `false` in production. If `devMode` is on and DAT restriction is disabled, anyone can access the restart and shutdown endpoints.)**
206
+ **(NOTE: Adding your DAT will give you access to Restart and Shutdown and Pause/Resume Users and other features in the Developer Panel)**
189
207
 
190
208
  ## Contacting The Developer Of Authtics Host
191
209