A React app that serves as client-side for true-layer-server.

This project's structure was cloned from a template I created - react-typescript-template - which in turn was originally bootstrapped with Create React App.

• true-layer-client
  • General Information
  • Table of Contents
  • Getting started
    • Pre-requisites
    • Installation
    • Available Scripts
    • npm start
    • npm test
    • npm run build
    • npm run eject
  • UI Architecture
  • Requirements
  • Implementation and Features
    • App State
    • HTTP requests
    • Routing
    • Responsiveness
    • TypeScript and schemas
  • Screenshots
  • Room for Improvement
  • License

• Install Node.js version 14.17.5

• Clone the repository via SSH

git clone [email protected]:HereBeAndre/true-layer-client.git

• Or clone it via HTTPS

git clone https://github.com/HereBeAndre/true-layer-client.git

• Install dependencies

cd true-client-client
npm install

The complete list of dependencies is included in ./package-lock.json.

• Run the project

npm start

The app is available at http://localhost:3000

In the project directory, you can run:

Runs the app in the development mode.
Open 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.

Launches Jest as test runner in the interactive watch mode.
React components are tested with React Testing Library.

Test files are created under ./src/__tests__ folder.

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 for more information.

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.

• Search field where you can type the Pokémon name;
• Show the Shakespearean description of the Pokémon;
• Basic styling - responsiveness included;

• No state management library was used;
• Heavy-lifting is done in App.tsx, therefore the majority of hooks is used there;
• I got away with using useState hook as I didn't need to share state with bottom-up / sibling components;
• Data is shared top-down between components via props.

• HTTPS requests are made with axios.

• Routing is handled with react-router-dom;
• Search params in URL are updated via useSearchParams() hook provided by react-router-dom.

• The app is fully responsive.

• Schemas are defined inside ./src/schemas folder.

WIP

Todo:

• Dockerize the app;
• Programmatically redirect user to main page if a non-existing route is visited;
• Add RegExp to validate user input in text field - i.e. support both latin and non-latin characters;
• Improve error handling - i.e. when backend is down;
• Implement environment variables management for production, development and testing envs;
• Improve test coverage.

Known bugs:

• List bugs here

This project is licensed under the terms of the MIT license.