Skip to content

Commit 727e873

Browse files
LucJosinLucJosin
authored
Feat: Setup (#1)
1 parent 985874c commit 727e873

22 files changed

+1165
-2
lines changed

‎.env.dev.example‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
DB_FOLDER=dev
2+
VERSION=v1
3+
API_URL=
4+
TOKEN=

‎.env.example‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
DB_FOLDER=database
2+
VERSION=v1
3+
API_URL=
4+
TOKEN=

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules/
2+
dev/
3+
4+
.env
5+
.env.dev

‎README.md‎

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,85 @@
1-
# api-data
2-
Static data from the HawAPI database
1+
# HawAPI - API-Data
2+
3+
Static data from the [HawAPI](https://github.com/HawAPI/HawAPI) project.
4+
5+
## Topics
6+
7+
- [Prerequisites](#prerequisites)
8+
- [Dependencies](#dependencies)
9+
- [Contributing](./docs/CONTRIBUTING.md)
10+
- [Requesting](./docs/REQUESTTING.md)
11+
- [Requesting#Static](./docs/REQUESTTING.md#static-data)
12+
- [Requesting#Translation](./docs/REQUESTTING.md#translation-data)
13+
- [Running](#running)
14+
- [Contact](#contact)
15+
- [License](#license)
16+
17+
## Prerequisites
18+
19+
- The **HawAPI** project running (and all its [prerequisites](https://github.com/HawAPI/HawAPI/blob/main/docs/GETTING_STARTED.md#prerequisites))
20+
- Node
21+
- Npm or Yarn for **run the script**
22+
23+
## Dependencies
24+
25+
- [dotenv](https://www.npmjs.com/package/dotenv)
26+
27+
## Setup
28+
29+
Step by step of how to run the application.
30+
31+
> See all [Prerequisites](#prerequisites)
32+
33+
### Clone
34+
35+
> **Note** \
36+
> Alternatively, you could [download all files (Zip)](https://github.com/HawAPI/website/archive/refs/heads/main.zip)
37+
38+
- SSH
39+
40+
```
41+
git clone [email protected]:HawAPI/website.git
42+
```
43+
44+
- HTTPS
45+
46+
```
47+
git clone https://github.com/HawAPI/website.git
48+
```
49+
50+
### Running
51+
52+
> Check [Requesting](./docs/REQUESTTING.md)
53+
54+
Before running the script:
55+
56+
-
57+
- Create and define all required variables inside the `.env`. Use [.env.example](.env.example) as reference.
58+
59+
If you are running using local HawAPI application create and define all required variables inside the `.env.dev` and use the `dev` command. Use [.env.dev.example](.env.dev.example) as reference.
60+
61+
#### Dev/Test
62+
63+
Using **dev** command all outputs will be stored on a `/dev/` folder.
64+
65+
```
66+
yarn dev
67+
```
68+
69+
#### Production
70+
71+
Using **start** command all outputs will be stored on a `/database/` folder.
72+
73+
```
74+
yarn start
75+
```
76+
77+
## Contact
78+
79+
For any questions about the project: [Contact](https://github.com/HawAPI/HawAPI#contact).
80+
81+
## License
82+
83+
HawAPI is licensed under the [MIT License](https://github.com/HawAPI/website/blob/main/LICENSE).
84+
85+
> Check out all [licenses/dependencies](https://hawapi.theproject.id/docs/about/#licenses)

‎database/v1/models/actor.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"first_name": "",
3+
"last_name": "",
4+
"nicknames": [""],
5+
"socials": [
6+
{
7+
"social": "",
8+
"handle": "",
9+
"url": ""
10+
}
11+
],
12+
"nationality": "",
13+
"birth_date": "",
14+
"death_date": "",
15+
"gender": 0,
16+
"seasons": [""],
17+
"awards": [""],
18+
"character": "",
19+
"thumbnail": "",
20+
"images": [""],
21+
"sources": "{}"
22+
}

‎database/v1/models/character.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"first_name": "",
3+
"last_name": "",
4+
"nicknames": [""],
5+
"birth_date": "",
6+
"death_date": "",
7+
"gender": 0,
8+
"actor": "",
9+
"thumbnail": "",
10+
"images": [""],
11+
"sources": "{}"
12+
}

‎database/v1/models/episode.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"language": "",
3+
"title": "",
4+
"description": "",
5+
"languages": [""],
6+
"duration": 0,
7+
"episode_num": 0,
8+
"next_episode": "",
9+
"prev_episode": "",
10+
"season": "",
11+
"thumbnail": "",
12+
"images": [""],
13+
"sources": "{}"
14+
}

‎database/v1/models/game.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"language": "",
3+
"name": "",
4+
"description": "",
5+
"trailer": "",
6+
"languages": [""],
7+
"release_date": "",
8+
"url": "",
9+
"publishers": [""],
10+
"developers": [""],
11+
"platforms": [""],
12+
"genres": [""],
13+
"thumbnail": "",
14+
"images": [""],
15+
"sources": "{}"
16+
}

‎database/v1/models/location.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"language": "",
3+
"name": "",
4+
"description": "",
5+
"languages": [""],
6+
"thumbnail": "",
7+
"images": [""],
8+
"sources": "{}"
9+
}

‎database/v1/models/season.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"language": "",
3+
"title": "",
4+
"description": "",
5+
"genres": [""],
6+
"trailers": [""],
7+
"languages": [""],
8+
"duration_total": 0,
9+
"season_num": 0,
10+
"next_season": "",
11+
"prev_season": "",
12+
"episodes": [""],
13+
"soundtracks": [""],
14+
"budget": "",
15+
"thumbnail": "",
16+
"images": [""],
17+
"sources": "{}"
18+
}

0 commit comments

Comments
 (0)