profydev / prolog-app

The base application for the upcoming React Job Simulator. Transition from amateur to professional within a single project by working in a real-world work environment.

This repository is part of the React Job Simulator where you work in a professional dev environment with advanced tooling and workflows. You implement tasks based on designs starting from small bug fixes to full-blown features. Basically, you learn a lot of the things hands-on that you usually only experience once you joined a professional React team.

The Application

The application is an error logging and monitoring tool similar to Sentry or Rollbar. You can find a deployed version of the main branch at prolog.profy.dev. Note: you have to click the "Dashboard" link in the upper right corner to see the app as shown in the screenshot below.

Codebase Tour

Watch this video for a tour through the codebase.

Getting Started

1. Clone & Install

This project is built with Next.js, TypeScript, Cypress & SCSS modules among others. To start working on the project, first clone the repository on your local machine and install the dependencies.

npm install

2. Create .env File

copy the .env.template file to a new file called .env. This file contains the required environment variables that are injected by Next.js via the dotenv package.

3. Run Development Server

Finally, run the development server:

npm run dev

Now you can open http://localhost:3000 with your browser to see the application.

Recommended VS Code Extensions

This project uses tools like ESLint, Stylelint, and Prettier. To make the most of these tools it's recommended to install the corresponding extensions. For VS Code those are:

• ESLint
• Stylelint
• Prettier
• SCSS IntelliSense (e.g. for auto-completion of SCSS variables)
• React CSS modules (e.g. to open the CSS class definition with CMD/Ctrl + click and warn about non-existent class names)

The official Stylelint extension might need some adjustment of your settings.json file. If it doesn't work out of the box try adding these lines:

"css.validate": false,
"less.validate": false,
"scss.validate": false,
"stylelint.validate": ["css", "scss"],

Additional extensions that I find very valuable are

Code Spell Checker GitLens SVG GitHub Copilot (paid)

Tests

This project is covered with Cypress tests. Although most tests for production apps are currently written with React Testing Library, Cypress is the best option to get started with testing. When you're new to testing the start can be very cumbersome and feel like you're in a completely new dev environment.

Cypress makes it much easier to get started with testing. You still have to get used to the new way of coding but thanks to its awesome UI debugging is easy and very similar to what you're used from your browser.

To run the Cypress tests on your local machine use this command:

npm run cypress

Storybook

Storybook is a great tool to document your components and visually test them in isolation. To open Storybook run

npm run storybook

prolog-app's Issues

Can't see orval config

IN this article https://profy.dev/article/react-openapi-typescript it mentions using orval and a link to the source

I didn't notice any orval settings or autogenerated api code in this codebase?

Can't get submitted code to pass CI - failing at prettier tests...

Hi I am about to enroll in your course but I am having an issue getting my first pull request pass the CI part. Specifically the prettier part. I am not sure if this is the right place to ask, but no matter what I do, the build fails the prettier test. I have run 'prettier --write .' on my code base, and then run 'prettier --check .' and get the following response:

yet when I upload I get constant Prettier warnings and as a result the checks fail.

What am I doing wrong?

This is my current repo:
https://github.com/profydev/prolog-app-PaulHaze/tree/header-updates-prettier-fixes

Like I said, I am keen to enroll, but I am wondering if I can't even get the first part working, it doesn't look good for me for the rest of the course! :)