Browse Source

initial steps.

canon
Elf M. Sternberg 2 years ago
commit
58200aa79b
  1. 29
      .gitignore
  2. 68
      CRA-DOC.md
  3. 79
      README.md
  4. BIN
      elder_scrolling_bg.png
  5. 43
      package.json
  6. BIN
      public/favicon.ico
  7. 43
      public/index.html
  8. BIN
      public/logo192.png
  9. BIN
      public/logo512.png
  10. 25
      public/manifest.json
  11. 3
      public/robots.txt
  12. 40
      src/App.scss
  13. 9
      src/App.test.js
  14. 23
      src/App.tsx
  15. 3
      src/cards/Cards.tsx
  16. 13
      src/index.css
  17. 18
      src/index.tsx
  18. 1
      src/react-app-env.d.ts
  19. 141
      src/serviceWorker.js
  20. 5
      src/setupTests.js
  21. 45
      src/styles/_colors.scss
  22. 59
      src/styles/_fonts.scss
  23. 14
      src/styles/_typography.scss
  24. 25
      tsconfig.json
  25. 11359
      yarn.lock

29
.gitignore vendored

@ -0,0 +1,29 @@
# 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*
# emacs detritus
*~
\#*
*\#
.\#*

68
CRA-DOC.md

@ -0,0 +1,68 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.<br />
You will also see any lint errors in the console.
### `yarn test`
Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn build`
Builds the app for production to the `build` folder.<br />
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.<br />
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t 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 you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t 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
### Analyzing the Bundle Size
This section has moved here: 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
### Advanced Configuration
This section has moved here: 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
### `yarn build` fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

79
README.md

@ -0,0 +1,79 @@
# Elder Scroll Display
## Synopsis
The Highspot Coding Challenge. The premise is to display a deck-builder
card catalog (such as Magic The Gathering, although in this case it's
Elder Scrolls) made available via a RESTful API. The requirements as
set out in the Code Challenge are:
### Requirements Checklist
- Show results in a card grid format with the image prominently displayed.
- Each card displays: Image, Name, Text, Set Name, and Type. Additional fields are optional.
- Display a loading indicator when communicating with the API.
- Use a responsive design that accommod_es, at minimum, desktop and mobile.
- Initially, fetch and display the first 20 results returned by the API.
- As the user scrolls down the page, load and append additional cards using "infinite scroll."
- Retrieve additional pages of results as-needed but do not load more than 20 cards with
each request.
- Allow the user to search for cards by Name.
- Use modern open-source web technologies to implement your solution (React, Backbone,
Angular, Vue, Underscore, etc.).
- Provide instructions for prerequisites, installation, and application setup and build in a
README file.
### Evaluation Criteria
- Are all stated requirements met?
- Does the application successfully build and run?
- Is the code well-organized and easy to understand?
- Does the code reflect contemporary web development techniques?
- Are functions and variables clearly named to express their purpose?
- Was the solution visually appealing?
- Were any scope decisions, TODO items, and known issues called out in
code comments or the README file?
### Available Resources
- Endpoint: https://api.elderscrollslegends.io/v1/cards
- Documentation: https://docs.elderscrollslegends.io/,
https://docs.elderscrollslegends.io/#api_v1cards_list
NOTE: The Elder Scrolls Legends API is a free, third-party service built
by an independent developer; it is not affiliated with Highspot, or with
the intellectual property owners of Elder Scrolls Legends. Please help
us use it responsibly.
### UNSTATED Requirement
- Does the app work well on both mobile and desktop platforms?
Although this requirement is not stated in the requirements checklist,
it is earlier stated that "A successful submission will function on
modern desktop and mobile browsers in a visually appealing way."
## Initial impressions
This is a single-page application. The 'search' is more of a filter,
sending the `?name=<param>` to the `/cards` API endpoint. To meet the
requirements of the application, the `pageSize=20` argument must be
passed to the endpoint.
Startup seems to be relatively straightforward, and there won't be
anything fancy here: A flexbox will probably do just fine, as will a
progressive fill. I'm inclined to _not_ use MaterialUI here; it's
probably overkill. Just an application, with some nice CSS and a decent
cache.
For the search feature, we'll want to go with whatever the API offers,
but when clearing the search, let's go for a fast reload with no data
requirements. That's provide some speed when going back to the basics.
I won't be using the ServiceWorker, as I don't feel confident enough in
my familiarity with it to make it matter.
Also, because I'm a *nerd*, I can't start without first picking out a
theme: white on black, with a paper texture from my design library
desaturated, darkened, and rendered a seamless tile, using the Google
'Marcellus' font, which kinda sorta looks Tolkeinesque.

BIN
elder_scrolling_bg.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

43
package.json

@ -0,0 +1,43 @@
{
"name": "elder_scrolling",
"version": "0.1.0",
"private": true,
"dependencies": {
"@testing-library/jest-dom": "^4.2.4",
"@testing-library/react": "^9.3.2",
"@testing-library/user-event": "^7.1.2",
"@types/jest": "^26.0.13",
"@types/node": "^14.10.2",
"@types/react": "^16.9.49",
"@types/react-dom": "^16.9.8",
"node-sass": "^4.14.1",
"react": "^16.13.1",
"react-dom": "^16.13.1",
"react-scripts": "3.4.3",
"sass": "^1.26.10"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"eslintConfig": {
"extends": "react-app"
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"devDependencies": {
"typescript": "^4.0.2"
}
}

BIN
public/favicon.ico

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.1 KiB

43
public/index.html

@ -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

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

BIN
public/logo512.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

25
public/manifest.json

@ -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

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

40
src/App.scss

@ -0,0 +1,40 @@
@import-normalize;
.App {
text-align: center;
}
.App-logo {
height: 40vmin;
pointer-events: none;
}
@media (prefers-reduced-motion: no-preference) {
.App-logo {
animation: App-logo-spin infinite 20s linear;
}
}
.App-header {
background-color: #282c34;
min-height: 100vh;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
font-size: calc(10px + 2vmin);
color: white;
}
.App-link {
color: #61dafb;
}
@keyframes App-logo-spin {
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
}

9
src/App.test.js

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

23
src/App.tsx

@ -0,0 +1,23 @@
import React from "react";
import "./App.scss";
import { Cards } from "./cards/Cards";
function App() {
return (
<div className="elder-scrolling">
<header>
<div className="left">
<h1>The Elder Scrolls</h1>
</div>
<div className="right">
<h2>Search goes here</h2>
</div>
</header>
<section>
<Cards />
</section>
</div>
);
}
export default App;

3
src/cards/Cards.tsx

@ -0,0 +1,3 @@
import * as React from "react";
export const Cards = () => <div>Cards go here</div>;

13
src/index.css

@ -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;
}

18
src/index.tsx

@ -0,0 +1,18 @@
import * as React from "react";
import * as ReactDOM from "react-dom";
import "./index.css";
import App from "./App";
import * as serviceWorker from "./serviceWorker";
const Bootstrap = (
<React.StrictMode>
<App />
</React.StrictMode>
);
ReactDOM.render(Bootstrap, document.getElementById("root"));
// If you want your app to work offline and load faster, you can change
// unregister() to register() below. Note this comes with some pitfalls.
// Learn more about service workers: https://bit.ly/CRA-PWA
serviceWorker.unregister();

1
src/react-app-env.d.ts vendored

@ -0,0 +1 @@
/// <reference types="react-scripts" />

141
src/serviceWorker.js

@ -0,0 +1,141 @@
// This optional code is used to register a service worker.
// register() is not called by default.
// This lets the app load faster on subsequent visits in production, and gives
// it offline capabilities. However, it also means that developers (and users)
// will only see deployed updates on subsequent visits to a page, after all the
// existing tabs open on the page have been closed, since previously cached
// resources are updated in the background.
// To learn more about the benefits of this model and instructions on how to
// opt-in, read https://bit.ly/CRA-PWA
const isLocalhost = Boolean(
window.location.hostname === 'localhost' ||
// [::1] is the IPv6 localhost address.
window.location.hostname === '[::1]' ||
// 127.0.0.0/8 are considered localhost for IPv4.
window.location.hostname.match(
/^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
)
);
export function register(config) {
if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
// The URL constructor is available in all browsers that support SW.
const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
if (publicUrl.origin !== window.location.origin) {
// Our service worker won't work if PUBLIC_URL is on a different origin
// from what our page is served on. This might happen if a CDN is used to
// serve assets; see https://github.com/facebook/create-react-app/issues/2374
return;
}
window.addEventListener('load', () => {
const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
if (isLocalhost) {
// This is running on localhost. Let's check if a service worker still exists or not.
checkValidServiceWorker(swUrl, config);
// Add some additional logging to localhost, pointing developers to the
// service worker/PWA documentation.
navigator.serviceWorker.ready.then(() => {
console.log(
'This web app is being served cache-first by a service ' +
'worker. To learn more, visit https://bit.ly/CRA-PWA'
);
});
} else {
// Is not localhost. Just register service worker
registerValidSW(swUrl, config);
}
});
}
}
function registerValidSW(swUrl, config) {
navigator.serviceWorker
.register(swUrl)
.then(registration => {
registration.onupdatefound = () => {
const installingWorker = registration.installing;
if (installingWorker == null) {
return;
}
installingWorker.onstatechange = () => {
if (installingWorker.state === 'installed') {
if (navigator.serviceWorker.controller) {
// At this point, the updated precached content has been fetched,
// but the previous service worker will still serve the older
// content until all client tabs are closed.
console.log(
'New content is available and will be used when all ' +
'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
);
// Execute callback
if (config && config.onUpdate) {
config.onUpdate(registration);
}
} else {
// At this point, everything has been precached.
// It's the perfect time to display a
// "Content is cached for offline use." message.
console.log('Content is cached for offline use.');
// Execute callback
if (config && config.onSuccess) {
config.onSuccess(registration);
}
}
}
};
};
})
.catch(error => {
console.error('Error during service worker registration:', error);
});
}
function checkValidServiceWorker(swUrl, config) {
// Check if the service worker can be found. If it can't reload the page.
fetch(swUrl, {
headers: { 'Service-Worker': 'script' },
})
.then(response => {
// Ensure service worker exists, and that we really are getting a JS file.
const contentType = response.headers.get('content-type');
if (
response.status === 404 ||
(contentType != null && contentType.indexOf('javascript') === -1)
) {
// No service worker found. Probably a different app. Reload the page.
navigator.serviceWorker.ready.then(registration => {
registration.unregister().then(() => {
window.location.reload();
});
});
} else {
// Service worker found. Proceed as normal.
registerValidSW(swUrl, config);
}
})
.catch(() => {
console.log(
'No internet connection found. App is running in offline mode.'
);
});
}
export function unregister() {
if ('serviceWorker' in navigator) {
navigator.serviceWorker.ready
.then(registration => {
registration.unregister();
})
.catch(error => {
console.error(error.message);
});
}
}

5
src/setupTests.js

@ -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/extend-expect';

45
src/styles/_colors.scss

@ -0,0 +1,45 @@
$white: #ffffff;
$cream: #f8f8f8;
$raven: #373d3f; // For body text
$jet: #131516; // For header text
$stone: #707c80; // For meta text
$pearl: #dadedf; // Meta elsewhere
$menufade: rgba(255, 255, 255, 0.2);
$whiteblur: rgba(252, 252, 252, 0.8);
$shadow: rgba(1, 1, 1, 0.15);
$shadowjet: rgba(19, 21, 20, 0.15);
$darkshadow: rgba(0, 0, 0, 0.1);
$clearjet: rgba(19, 21, 20, 0.1);
$lightjet: rgba(19, 21, 20, 0.6);
$bigorange: #ef6c00;
$color-background: #fcfcfc;
$color-text: #2C3531;
$color-primary-0: #EF6C00; // Main Primary color */
$color-primary-1: #FF9E4E;
$color-primary-2: #FF8A29;
$color-primary-3: #C15800;
$color-primary-4: #9D4700;
$color-secondary-1-0: #EF9F00; // Main Secondary color (1) */
$color-secondary-1-1: #FFC44E;
$color-secondary-1-2: #FFB829;
$color-secondary-1-3: #C18100;
$color-secondary-1-4: #9D6800;
$color-secondary-2-0: #113CA0; // Main Secondary color (2) */
$color-secondary-2-1: #4669BA;
$color-secondary-2-2: #2B53AF;
$color-secondary-2-3: #0D3082;
$color-secondary-2-4: #092669;
$color-complement-0: #008F8F; // Main Complement color */
$color-complement-1: #34ACAC;
$color-complement-2: #199E9E;
$color-complement-3: #007474;
$color-complement-4: #005E5E;

59
src/styles/_fonts.scss

@ -0,0 +1,59 @@
$unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
$josefinfonts:
100 Thin normal,
100 ThinItalic italic,
200 ExtraLight normal,
200 ExtraLight italic,
300 Light normal,
300 LightItalic italic,
400 Regular normal,
400 RegularItalic italic,
500 Medium normal,
500 MediumItalic italic,
600 SemiBold normal,
600 SemiBoldItalic italic,
700 Bold normal,
700 Bold italic;
@each $weight, $filename, $style in $josefinfonts {
@font-face {
font-family: 'JosefinSans';
font-style: $style;
font-weight: $weight;
src: url("./fonts/JosefinSans-#{$filename}.woff2") format("woff"),
url("./fonts/JosefinSans-#{$filename}.ttf") format("truetype");
unicode-range: $unicode-range;
}
}
$cardofonts:
400 Regular normal,
400 Italic italic,
700 Bold normal;
@each $weight, $filename, $style in $cardofonts {
@font-face {
font-family: 'Cardo';
font-style: $style;
font-weight: $weight;
src: url("./fonts/Cardo-#{$filename}.woff2") format("woff"),
url("./fonts/Cardo-#{$filename}.ttf") format("truetype");
unicode-range: $unicode-range;
}
}
$firafonts:
400 Regular normal,;
@each $weight, $filename, $style in $firafonts {
@font-face {
font-family: 'FiraCode';
font-style: $style;
font-weight: $weight;
src: url("./fonts/FiraCode-#{$filename}.woff2") format("woff"),
url("./fonts/Fira-#{$filename}.ttf") format("truetype");
unicode-range: $unicode-range;
}
}

14
src/styles/_typography.scss

@ -0,0 +1,14 @@
html {
font-size: 62.5%; // A common trick: now everything "2.0" rem will be 20pixels
-webkit-font-smoothing: antialiased;
a {
-webkit-font-smoothing: antialiased;
}
}
body {
line-height: 1.88;
font-size: 1.8rem;
}

25
tsconfig.json

@ -0,0 +1,25 @@
{
"compilerOptions": {
"target": "es5",
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"module": "esnext",
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react"
},
"include": [
"src"
]
}

11359
yarn.lock

File diff suppressed because it is too large Load Diff
Loading…
Cancel
Save