Giter Site home page Giter Site logo

jorgeamendoza / recipe-page Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 7.24 MB

Recipe Page challenge provided thanks to FrontEndMentors

Home Page: https://recipe-page-gamma-brown.vercel.app

License: MIT License

JavaScript 13.10% TypeScript 50.60% HTML 2.58% CSS 33.73%

recipe-page's Introduction

My React + TypeScript + Vite Template

image of desktop preview of the recipe list

Design, assets, and requirements provided by Frontend Mentor.

The goal of this challenge is to create an accessible, semantic, and responsive recipe list page. Though the page could be constructed using nothing but div, taking the time to research properly implement semantic HTML will lead to the following.

  • Improved web crawling
  • Better accessibility
  • Better SEO

Table of Contents

Technologies Used

This application was bootstrapped with Vite, specifically, using the custom development configuration I created. This project is linted and formatted with ESLint and Prettier. Please see the eslintrc.cjs and .prettierrc for the rules implemented. Since the page is relatively simple, I decided to not create a CI/CD pipeline.

Some of the tools used in this web app include:

  • React, library/framework for building user interfaces.
  • Typescript, a superset of Javascript that adds static typing.
  • CSS Modules

No other major libraries were used, I wanted to keep this as simple as possible (though I know even using React is a bit overkill, but I wanted to also start using the tempalte I created).

Installation

Please follow the instructions below to install and run the application locally:

  1. Clone the repository to your machine with the command git clone https://github.com/JorgeAMendoza/recipe-page.
  2. cd into the project directory.
  3. Run npm install to install the dependencies.
  4. Run npm run dev to start the development server.
  5. Open localhost:3000 in your browser to view the application.

To run intergration test, either run npm run cypress:open to open the Cypress UI, or npm run cypress:run to run the tests in the terminal. Unit test can be run with npm test.

Development

There isn't much to say about the development, the last project I worked on had me focus on my React skills, so I wanted to use this challenge to refresh some of my CSS skills with CSS modules. This challenge also allowed me to review semantic HTML, accessibility, and learn more about using the chrome dev tools to debug accessibility issues.

Conclusion

From this type of project, there isn't much to take away. Though, it was nice to get a review on some CSS techniques, accessibility tools, and semantic HTML.

recipe-page's People

Contributors

jorgeamendoza avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.