Skip to content

Commit e09bb5d

Browse files
LucJosinLucJosin
committed
feat: Update docs
- Replace `README.md` with `index.md` - Update scroll width - Update retype config (url)
1 parent d3e73e4 commit e09bb5d

4 files changed

Lines changed: 156 additions & 83 deletions

File tree

‎README.md‎

Lines changed: 47 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,73 @@
1-
---
2-
icon: home
3-
---
1+
# HawAPI - Docs
42

5-
# Introduction
3+
Docs for the [HawAPI](https://github.com/HawAPI/HawAPI) project.
64

7-
The **HawAPI** is a Free and <a href="{{git_home}}/" target="_blank">Open Source :icon-link-external:</a> API for <a href="https://www.netflix.com/title/80057281" target="_blank">Stranger Things :icon-link-external:</a> show.
5+
## Topics
86

9-
All this information is available through a RESTful API implemented with [_Java (Spring Boot) + PostgreSQL_](/About.md#tech-stack) and served via **JSON** and allows developers to create **desktop**, **web** and **mobile** applications using this data very easy.
7+
- [Prerequisites](#prerequisites)
8+
- [Dependencies](#dependencies)
9+
- [Running](#running)
10+
- [Contact](#contact)
11+
- [License](#license)
1012

11-
## Quickstart
13+
## Prerequisites
1214

13-
:::tiles
14-
<a href="./guides/i18n" class="title-box">I18N<span class="subtitle">Internationalization Support</span></a>
15+
- Node
16+
- Npm or Yarn for **run the script**
1517

16-
<a href="./guides/filters" class="title-box">Filters<span class="subtitle">Endpoint Filters</span></a>
18+
## Dependencies
1719

18-
<a href="./guides/rate-limiting" class="title-box">Rate Limiting<span class="subtitle">API Limits & Tiers</span></a>
20+
- [retype](https://www.npmjs.com/package/retypeapp)
1921

20-
<a href="./guides/authentication" class="title-box">Authentication<span class="subtitle">API Authentication</span></a>
22+
## Setup
2123

22-
<a href="./guides/caching" class="title-box">Caching<span class="subtitle">Cache & Validation</span></a>
24+
Step by step of how to run the application.
2325

24-
<a href="./guides/cors" class="title-box">CORS<span class="subtitle">Cross-Origin Request</span></a>
26+
> See all [Prerequisites](#prerequisites)
2527
26-
<a href="./javadoc/apidocs/" class="title-box">Javadoc<span class="subtitle">Generated Docs</span></a>
28+
### Clone
2729

28-
<a href="./faq" class="title-box">FAQ<span class="subtitle">Common questions</span></a>
29-
:::
30+
> **Note** \
31+
> Alternatively, you could [download all files (Zip)](https://github.com/HawAPI/docs/archive/refs/heads/main.zip)
3032
31-
## About
33+
- SSH
3234

33-
:::tiles
34-
<a href="./about#fair-use-policy" class="title-box">Maintainers<span class="subtitle">Project Maintainers</span></a>
35+
```
36+
git clone [email protected]:HawAPI/docs.git
37+
```
3538

36-
<a href="./about#fair-use-policy" class="title-box">Fair Use Policy<span class="subtitle">Controlling usage</span></a>
39+
- HTTPS
3740

38-
<a href="./about#copyright" class="title-box">Copyright<span class="subtitle">Data and images are used</span></a>
41+
```
42+
git clone https://github.com/HawAPI/docs.git
43+
```
3944

40-
<a href="./about#licenses" class="title-box">Licenses<span class="subtitle">All licenses of the project</span></a>
41-
:::
45+
### Running
4246

43-
<style>
44-
.tiles {
45-
width: 100%;
46-
text-align: center;
47-
color: #1956AF;
48-
display: grid;
49-
grid-template-columns: repeat(4, 0.2fr);
50-
justify-content: start;
51-
}
47+
> Check [Requesting](./docs/REQUESTTING.md)
5248
53-
.tiles p .title-box {
54-
height: 7rem;
55-
width: 12rem;
56-
border: 1px solid #fff;
57-
margin: 0 1rem;
58-
border-radius: 20px;
59-
display: flex;
60-
flex-direction: column;
61-
align-items: center;
62-
justify-content: center;
63-
transition: 250ms;
64-
color: #fff !important;
65-
text-decoration: none !important;
66-
}
49+
#### Dev/Test
6750

68-
.tiles p .title-box .subtitle {
69-
font-size: 0.725em;
70-
}
51+
Using **dev** command all outputs will be stored on memory.
7152

72-
.tiles p:hover .title-box {
73-
border: 1px solid rgb(179 0 0/var(--tw-text-opacity));
74-
color: rgb(179 0 0/var(--tw-text-opacity)) !important;
75-
}
53+
```
54+
yarn dev
55+
```
7656

77-
@media (max-width: 1500px) {
78-
.tiles {
79-
grid-template-columns: repeat(3, 0.2fr);
80-
}
81-
}
57+
#### Production
8258

83-
@media (max-width: 1300px) {
84-
.tiles {
85-
grid-template-columns: repeat(2, 0.2fr);
86-
}
87-
}
59+
Using **build** command all outputs will be stored on a `/build/` folder.
8860

89-
@media (max-width: 480px) {
90-
.tiles {
91-
justify-content: space-evenly;
92-
}
61+
```
62+
yarn build
63+
```
9364

94-
.tiles p .title-box {
95-
height: 6rem;
96-
width: 11rem;
97-
margin: 0 0.5rem;
98-
}
99-
}
65+
## Contact
10066

101-
@media (max-width: 400px) {
102-
.tiles p .title-box {
103-
height: 6rem;
104-
width: 9rem;
105-
}
106-
}
107-
</style>
67+
For any questions about the project: [Contact](https://github.com/HawAPI/HawAPI#contact).
68+
69+
## License
70+
71+
HawAPI is licensed under the [MIT License](https://github.com/HawAPI/docs/blob/main/LICENSE).
72+
73+
> Check out all [licenses/dependencies](https://hawapi.theproject.id/docs/about/#licenses)

‎_includes/head.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444
/* Scroll */
4545
::-webkit-scrollbar {
46-
width: 8px;
46+
width: 7px;
4747
background-color: transparent;
4848
}
4949

‎index.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
icon: home
3+
---
4+
5+
# Introduction
6+
7+
The **HawAPI** is a Free and <a href="{{git_home}}/" target="_blank">Open Source :icon-link-external:</a> API for <a href="https://www.netflix.com/title/80057281" target="_blank">Stranger Things :icon-link-external:</a> show.
8+
9+
All this information is available through a RESTful API implemented with [_Java (Spring Boot) + PostgreSQL_](/About.md#tech-stack) and served via **JSON** and allows developers to create **desktop**, **web** and **mobile** applications using this data very easy.
10+
11+
## Quickstart
12+
13+
:::tiles
14+
<a href="./guides/i18n" class="title-box">I18N<span class="subtitle">Internationalization Support</span></a>
15+
16+
<a href="./guides/filters" class="title-box">Filters<span class="subtitle">Endpoint Filters</span></a>
17+
18+
<a href="./guides/rate-limiting" class="title-box">Rate Limiting<span class="subtitle">API Limits & Tiers</span></a>
19+
20+
<a href="./guides/authentication" class="title-box">Authentication<span class="subtitle">API Authentication</span></a>
21+
22+
<a href="./guides/caching" class="title-box">Caching<span class="subtitle">Cache & Validation</span></a>
23+
24+
<a href="./guides/cors" class="title-box">CORS<span class="subtitle">Cross-Origin Request</span></a>
25+
26+
<a href="./javadoc/apidocs/" class="title-box">Javadoc<span class="subtitle">Generated Docs</span></a>
27+
28+
<a href="./faq" class="title-box">FAQ<span class="subtitle">Common questions</span></a>
29+
:::
30+
31+
## About
32+
33+
:::tiles
34+
<a href="./about#fair-use-policy" class="title-box">Maintainers<span class="subtitle">Project Maintainers</span></a>
35+
36+
<a href="./about#fair-use-policy" class="title-box">Fair Use Policy<span class="subtitle">Controlling usage</span></a>
37+
38+
<a href="./about#copyright" class="title-box">Copyright<span class="subtitle">Data and images are used</span></a>
39+
40+
<a href="./about#licenses" class="title-box">Licenses<span class="subtitle">All licenses of the project</span></a>
41+
:::
42+
43+
<style>
44+
.tiles {
45+
width: 100%;
46+
text-align: center;
47+
color: #1956AF;
48+
display: grid;
49+
grid-template-columns: repeat(4, 0.2fr);
50+
justify-content: start;
51+
}
52+
53+
.tiles p .title-box {
54+
height: 7rem;
55+
width: 12rem;
56+
border: 1px solid #fff;
57+
margin: 0 1rem;
58+
border-radius: 20px;
59+
display: flex;
60+
flex-direction: column;
61+
align-items: center;
62+
justify-content: center;
63+
transition: 250ms;
64+
color: #fff !important;
65+
text-decoration: none !important;
66+
}
67+
68+
.tiles p .title-box .subtitle {
69+
font-size: 0.725em;
70+
}
71+
72+
.tiles p:hover .title-box {
73+
border: 1px solid rgb(179 0 0/var(--tw-text-opacity));
74+
color: rgb(179 0 0/var(--tw-text-opacity)) !important;
75+
}
76+
77+
@media (max-width: 1500px) {
78+
.tiles {
79+
grid-template-columns: repeat(3, 0.2fr);
80+
}
81+
}
82+
83+
@media (max-width: 1300px) {
84+
.tiles {
85+
grid-template-columns: repeat(2, 0.2fr);
86+
}
87+
}
88+
89+
@media (max-width: 480px) {
90+
.tiles {
91+
justify-content: space-evenly;
92+
}
93+
94+
.tiles p .title-box {
95+
height: 6rem;
96+
width: 11rem;
97+
margin: 0 0.5rem;
98+
}
99+
}
100+
101+
@media (max-width: 400px) {
102+
.tiles p .title-box {
103+
height: 6rem;
104+
width: 9rem;
105+
}
106+
}
107+
</style>

‎retype.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
input: .
22
output: ./build/
3-
url: https://hawapi.theproject.id
3+
url: https://hawapi.theproject.id/docs
44
cname: false
55
branding:
66
title: HawAPI

0 commit comments

Comments
 (0)