OpenClassrooms - Project 6

Table of Contents

• 📖 Project
• 🧑‍💻 Stack
• 🚀 Project Commands
  • 🖥️ Launch Website
  • 🐛 Run Linter
  • 👓 Check Accessibility

📖 Project

This project is the 6th project of OpenClassrooms JavaScript - React Developer Program.
The objective is to improve the accessibility of a legacy project. It implies that the website will be complied with the WCAG.

🔼 Back to the Table of Contents

🧑‍💻 Stack

Here is the stack used in the project :

• 🖥️ Website
  • HTML
  • CSS
  • JavaScript
  • Vite
• Miscellaneous
  • ESLint
  • Pa11y

🔼 Back to the Table of Contents

🚀 Project Commands

🖥️ Launch Website

To start the website, do the following :

1. Open a terminal
2. Place yourself in the project folder
3. Run npm i to install the project dependencies
4. Then, run npm run dev to start Fisheye website

🎉 Vite will open the project in a browser tab !

🔼 Back to the Table of Contents

🐛 Run Linter

To run ESLint, follow the steps :

1. Open a terminal
2. Place yourself in the project with cd ./oc-p6-fisheye
3. Run npm run eslint command

🎉 ESLint will check .js, .css & .html files but ignores node_modules/ !

🔼 Back to the Table of Contents

👓 Check Accessibility

To check the accessibility of the project, run the following command npm run pa11y [paste the URL to check].

🎉 Congrats ! You checked the website accessibility !

🔼 Back to the Table of Contents