Add version number and best practices

This commit is contained in:
Florine W. Dekker 2020-03-14 12:58:33 +01:00
parent e795f96e00
commit 3204a76983
Signed by: FWDekker
GPG Key ID: B1B567AF58D6EE0F
3 changed files with 235 additions and 211 deletions

11
.editorconfig Normal file
View File

@ -0,0 +1,11 @@
root = true
[*]
charset = utf-8
trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 4

11
README.md Normal file
View File

@ -0,0 +1,11 @@
# Random _Fallout 76_ records
Allows a user to retrieve a random record from the _Fallout 76_ game files.
The user can filter records by data type to avoid receiving uninteresting data types.
The back end, `api.php`, communicates with an SQLite database, `fo76-dumps-ids.db`, containing only the `IDS.csv` dump
from [the _Fallout 76_ data dumps repository](https://github.com/FWDekker/fo76-dumps/).
The database is not included in this repository.
The front end, `index.html`, sends asynchronous queries to the back end based on the user's settings.
Selected data types are stored in a cookie so the user doesn't have to redo their settings each time the page is
refreshed.

View File

@ -10,14 +10,9 @@
<title>Random Fallout 76 record</title> <title>Random Fallout 76 record</title>
<link rel="shortcut icon" href="https://fwdekker.com/favicon.ico" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic" <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic"
crossorigin="anonymous" /> crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.1/normalize.min.css" <link rel="stylesheet" href="https://static.fwdekker.com/css/milligram-bundle.min.css" crossorigin="anonymous" />
integrity="sha256-l85OmPOjvil/SOvVt3HnSSjzF1TUMyT9eV0c2BzEGzU=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/milligram/1.3.0/milligram.min.css"
integrity="sha256-Ro/wP8uUi8LR71kwIdilf78atpu8bTEwrK5ZotZo+Zc=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://static.fwdekker.com/css/milligram-common.css" crossorigin="anonymous" />
</head> </head>
<body> <body>
<main class="wrapper"> <main class="wrapper">
@ -25,8 +20,15 @@
<header class="header"> <header class="header">
<div class="container"> <div class="container">
<h1>Random Fallout 76 record</h1> <h1>Random Fallout 76 record</h1>
<noscript>
<span style="color: red; font-weight: bold;">
This website does not function if JavaScript is disabled.
Please check the <a href="https://www.enable-javascript.com/">
instructions on how to enable JavaScript in your web browser</a>.
</span>
</noscript>
<p> <p>
On this page you can retrieve a random record from the Fallout 76 game files. On this page you can retrieve a random record from the <i>Fallout 76</i> game files.
Simply select the signatures you want to include below, and then press the "Get random record" Simply select the signatures you want to include below, and then press the "Get random record"
button. button.
</p> </p>
@ -56,12 +58,12 @@
<!-- Footer --> <!-- Footer -->
<footer class="footer"> <footer class="footer">
<section class="container"> <section class="container">
<div class="footer">
Made by <a href="https://fwdekker.com/">Felix W. Dekker</a>. Made by <a href="https://fwdekker.com/">Felix W. Dekker</a>.
Licensed under the Licensed under the
<a href="https://git.fwdekker.com/FWDekker/random-fo76/src/branch/master/LICENSE">MIT License</a>. <a href="https://git.fwdekker.com/FWDekker/random-fo76/src/branch/master/LICENSE">MIT License</a>.
Source code available on <a href="https://git.fwdekker.com/FWDekker/random-fo76/">git</a>. Source code available on <a href="https://git.fwdekker.com/FWDekker/random-fo76/">git</a>.
</div>
<div style="float: right;">v1.0.6</div>
</section> </section>
</footer> </footer>
</main> </main>