Transfer the webpage from a personal repo to this one

pull/1/head
Brogan Clements 2022-01-27 14:47:59 -06:00
parent 46bf6c481e
commit 37de9d0443
22 changed files with 38104 additions and 1 deletions

23
.gitignore vendored Normal file
View File

@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
/node_modules
/.pnp
.pnp.js
# testing
/coverage
# production
/build
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*

View File

@ -1 +1,70 @@
# ree-programming-books-search # Free Programming Books earch
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
If you arent satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point youre on your own.
You dont have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

16381
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

49
package.json Normal file
View File

@ -0,0 +1,49 @@
{
"homepage": "https://brogan20.github.io/search-fpb/",
"name": "my-app",
"version": "0.1.0",
"private": true,
"dependencies": {
"@testing-library/jest-dom": "^5.14.1",
"@testing-library/react": "^11.2.7",
"@testing-library/user-event": "^12.8.3",
"axios": "^0.24.0",
"express": "^4.17.1",
"fuse": "^0.4.0",
"fuse.js": "^6.4.6",
"jQuery": "^1.7.4",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-scripts": "4.0.3",
"web-vitals": "^1.1.2"
},
"scripts": {
"predeploy": "npm rum build",
"deploy": "gh-pages -d build",
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"eslintConfig": {
"extends": [
"react-app",
"react-app/jest"
]
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"devDependencies": {
"gh-pages": "^3.2.3"
}
}

BIN
public/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 KiB

43
public/index.html Normal file
View File

@ -0,0 +1,43 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Web site created using create-react-app"
/>
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
<!--
manifest.json provides metadata used when your web app is installed on a
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>React App</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>

BIN
public/logo192.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

BIN
public/logo512.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

25
public/manifest.json Normal file
View File

@ -0,0 +1,25 @@
{
"short_name": "React App",
"name": "Create React App Sample",
"icons": [
{
"src": "favicon.ico",
"sizes": "64x64 32x32 24x24 16x16",
"type": "image/x-icon"
},
{
"src": "logo192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "logo512.png",
"type": "image/png",
"sizes": "512x512"
}
],
"start_url": ".",
"display": "standalone",
"theme_color": "#000000",
"background_color": "#ffffff"
}

3
public/robots.txt Normal file
View File

@ -0,0 +1,3 @@
# https://www.robotstxt.org/robotstxt.html
User-agent: *
Disallow:

40
src/App.css Normal file
View File

@ -0,0 +1,40 @@
body {
box-sizing: border-box;
background-color: #222222;
}
#root {
box-sizing: border-box;
}
.frontPage {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen",
"Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue",
sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
display: flex;
flex-direction: column;
height: 100;
color: whitesmoke;
text-align: center;
justify-content: center;
}
.search-results {
justify-content: center;
align-items: flex-start;
display: flex;
flex-direction: row;
flex-flow: row wrap;
box-sizing: border-box;
/* justify-content: normal ; */
align-content: flex-start;
padding-left: 1em;
padding-right: 1em;
}
.result {
width: 30%;
padding: 0.25em 0.5em;
}

221
src/App.js Normal file
View File

@ -0,0 +1,221 @@
import React, { useState, useEffect } from "react";
import LangDropdown from "./components/LangDropdown";
import SearchBar from "./components/SearchBar";
import SearchResult from "./components/SearchResult";
import axios from "axios";
import Fuse from "fuse.js";
const fpb = require("./fpb.json"); //local copy of json becuase online currently can't be accessed
// eslint-disable-next-line
function makeBook(author, hLang, cLang, title, url) {
//returns a struct with basic book info (author, human language, computer language, book title, url)
return {
author: author,
hLang: hLang, //human language
cLang: cLang, //computer language
title: title,
url: url,
};
}
// eslint-disable-next-line
function forEachBook(func, json) {
//Runs func on each section, entry, and book in json, which is a list of entries
if (typeof func !== "function") {
// eslint-disable-next-line
throw "ERROR in forEachBook: parameter not a fucntion";
}
for (const hLang in json) { //for each human language
if (Array.isArray(hLang.sections)) {
//check if sections is an array
hLang.sections.forEach(
(
cLang //for each computer lanuage
) => {
if (Array.isArray(cLang.entries)) {
//verify is entries is an array
cLang.entries.forEach(
(
book //for each book
) => {
if (typeof book === "object") {
//verify that book is an object
func(json[hLang], cLang, book); //run the function
}
}
);
}
}
);
}
}
}
// Sorts search results by their score
// eslint-disable-next-line
function sortByScore(results) {
results.sort(function (a, b) {
return a.score - b.score;
});
return results;
}
function jsonToArray(json) {
let arr = [];
let sections = [];
json.children[0].children.forEach((document) => {
document.sections.forEach((section) => {
if (!sections.includes(section.section)) sections.push(section.section);
section.entries.forEach((entry) => {
arr.push({
author: entry.author,
title: entry.title,
url: entry.url,
lang: document.language,
section: section.section,
});
});
section.subsections.forEach((subsection) => {
subsection.entries.forEach((entry) => {
arr.push({
author: entry.author,
title: entry.title,
url: entry.url,
lang: document.language,
section: section.section,
subsection: subsection.section,
});
});
});
});
});
return { arr: arr, sections: sections };
}
function App() {
const [data, setData] = useState(undefined); // keeps the state of the json
const [dataArray, setDataArray] = useState([]); // put everything into one array. uses more memory, but search is faster and less complex
// eslint-disable-next-line
const [index, setIndex] = useState([]); // used for "table of contents". currently unused
const [loading, setLoading] = useState(true); // Determines whether to show spinner
const [searchParams, setSearchParams] = useState({ title: "" });
const [searchResults, setSearchResults] = useState([]);
const [sectionResults, setSectionResults] = useState([]);
// eslint-disable-next-line
const [error, setError] = useState("");
let resultsList = null; // the html string containing the search results
let sectionResultsList = null;
const changeParameter = (param, value) => {
// Lets a child component set the value of the search term
setSearchParams({ ...searchParams, [param]: value });
};
// fetches data the first time the page renders
useEffect(() => {
async function fetchData() {
try {
setLoading(true);
let result = await axios.get(
"https://raw.githubusercontent.com/FreeEbookFoundationBot/free-programming-books-json/main/fpb.json"
);
setData(result.data);
let { arr, sections } = jsonToArray(result.data);
setDataArray(arr);
setIndex(sections);
} catch (e) {
// setError("Couldn't get data. Please try again later")
setData(fpb);
let { arr, sections } = jsonToArray(fpb);
setIndex(sections);
setDataArray(arr);
}
setLoading(false);
}
fetchData();
}, []);
// fires when searchTerm changes
// THIS IS THE MAIN SEARCH FUNCTION CURRENTLY
useEffect(() => {
if (dataArray) {
// Finds most relevant titles
const fuseOptions = {
useExtendedSearch: true,
findAllMatches: true,
shouldSort: true,
includeScore: true,
threshold: 0.2,
keys: ["title", "lang.code"],
};
let fuse = new Fuse(dataArray, fuseOptions);
let query = [];
for (const [key, value] of Object.entries(searchParams)) {
if (value === null || value === "") continue;
if (key === "lang.code") {
query.push({ "lang.code": `^${value}` });
continue;
}
query.push({ [key]: value });
}
let result = fuse.search({
$and: query,
});
result = result.slice(0, 40);
setSearchResults(result);
let sResults = []; // section results
// Finds the most relevant sections
result.forEach((entry) => {
let section = entry.item.section;
if (!sResults.includes(section)) sResults.push(section);
});
setSectionResults(sResults);
}
}, [searchParams, dataArray]);
if (loading) {
// if still fetching resource
return <h1>Loading...</h1>;
}
if (error) {
return <h1>Error: {error}</h1>;
}
if (searchParams.title && searchResults.length !== 0) {
resultsList =
searchResults &&
searchResults.map((entry) => {
return <SearchResult data={entry.item} />;
});
sectionResultsList =
sectionResults &&
sectionResults.map((section) => {
return <li>{section}</li>;
});
}
return (
<div className="frontPage">
<h1>Free Programming Books</h1>
<div>
<SearchBar changeParameter={changeParameter} />
<LangDropdown changeParameter={changeParameter} data={data} />
</div>
<h2>Section Results</h2>
{sectionResultsList && (
<p>
This feature is not complete! For now, use this to help reference the
markdown documents on the main respository.
</p>
)}
<div className="search-results">{sectionResultsList}</div>
<h2>Top Results</h2>
<div className="search-results">{resultsList}</div>
</div>
);
}
export default App;

8
src/App.test.js Normal file
View File

@ -0,0 +1,8 @@
import { render, screen } from '@testing-library/react';
import App from './App';
test('renders learn react link', () => {
render(<App />);
const linkElement = screen.getByText(/learn react/i);
expect(linkElement).toBeInTheDocument();
});

View File

@ -0,0 +1,57 @@
import React, { useState, useEffect } from "react";
function LangDropdown({ changeParameter, data }) {
const [languages, setLanguages] = useState([]);
let options = null;
const handleChange = (e) => {
changeParameter("lang.code", e.target.value);
};
useEffect(
// run whenever data changes
() => {
if (data) {
let langArray = [];
data.children[0].children.forEach((document) => {
if (
typeof document.language.name === "string" &&
document.language.name.length > 0
) {
//make sure the language is valid and not blank
//console.log("LANGUAGE: " + document.language.name)
langArray.push(document.language);
}
});
langArray.sort((a, b) => a.name > b.name);
setLanguages(langArray);
}
},
[data]
);
const createOption = (language) => {
return (
<option class="lang" key={language.code} value={language.code}>
{language.name}
</option>
);
};
options =
languages &&
languages.map((language) => {
return createOption(language);
});
// console.log(options);
return (
<select onChange={handleChange} name="languages" id="languages">
<option key="allLangs" value="">
All Languages
</option>
{options}
</select>
);
}
export default LangDropdown;

View File

@ -0,0 +1,26 @@
import React from "react";
function SearchBar(props) {
const handleChange = (e) => {
props.changeParameter("title", e.target.value);
};
return (
<form
onSubmit={(e) => {
e.preventDefault();
}}
name="searchBar"
>
<input
autoComplete="off"
type="text"
name="searchTerm"
placeholder="Enter Book Name"
onChange={handleChange}
/>
</form>
);
}
export default SearchBar;

View File

@ -0,0 +1,17 @@
import React from "react";
function SearchResult({ data }) {
return (
<div class="result">
<h3>
<a href={data.url} target="_blank">
{data.title}
</a>
</h3>
<h4>by {data.author ? data.author : "Unknown Author"}</h4>
<p>({data.lang.code})</p>
</div>
);
}
export default SearchResult;

21092
src/fpb.json Normal file

File diff suppressed because it is too large Load Diff

13
src/index.css Normal file
View File

@ -0,0 +1,13 @@
body {
margin: 0;
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
code {
font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
monospace;
}

17
src/index.js Normal file
View File

@ -0,0 +1,17 @@
import React from 'react';
import ReactDOM from 'react-dom';
import './App.css';
import App from './App';
import reportWebVitals from './reportWebVitals';
ReactDOM.render(
<React.StrictMode>
<App />
</React.StrictMode>,
document.getElementById('root')
);
// If you want to start measuring performance in your app, pass a function
// to log results (for example: reportWebVitals(console.log))
// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
reportWebVitals();

1
src/logo.svg Normal file
View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3"><g fill="#61DAFB"><path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/><circle cx="420.9" cy="296.5" r="45.7"/><path d="M520.5 78.1z"/></g></svg>

After

Width:  |  Height:  |  Size: 2.6 KiB

13
src/reportWebVitals.js Normal file
View File

@ -0,0 +1,13 @@
const reportWebVitals = onPerfEntry => {
if (onPerfEntry && onPerfEntry instanceof Function) {
import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
getCLS(onPerfEntry);
getFID(onPerfEntry);
getFCP(onPerfEntry);
getLCP(onPerfEntry);
getTTFB(onPerfEntry);
});
}
};
export default reportWebVitals;

5
src/setupTests.js Normal file
View File

@ -0,0 +1,5 @@
// jest-dom adds custom jest matchers for asserting on DOM nodes.
// allows you to do things like:
// expect(element).toHaveTextContent(/react/i)
// learn more: https://github.com/testing-library/jest-dom
import '@testing-library/jest-dom';