Skip to content

mattscholta/portfolio-nextjs

Repository files navigation

πŸ§‘β€πŸ’» Matthew Scholta

Lorem ipsum dolor sit amet consectetur adipisicing elit. Ipsum id ea vitae explicabo ut harum, atque vel. Est aut nisi omnis, voluptatum, laudantium dolores vel sit delectus debitis velit consequatur. Lorem ipsum dolor, sit amet consectetur adipisicing elit. Illo vitae corporis maxime quam, facilis porro. Est fuga, vel repellendus officiis neque totam ut itaque accusamus beatae assumenda sit recusandae optio.

Resources & Tech:

βš™οΈ Installation

Lorem ipsum dolor sit amet consectetur adipisicing elit. Nesciunt voluptas adipisci incidunt autem expedita eaque et ex aliquam? Accusantium cupiditate, similique dolores ea minima vitae sequi. Pariatur, non. Perspiciatis, maxime.

# πŸ“¦ Install our NPM Packages
npm install

# πŸ—οΈ Build the app once
npm run build

πŸ§‘β€πŸ’» Development

Getting started coding is simple, once you've completed the "installation" section above, you can startup local development with the following commands:

# πŸ”₯ Fast Refresh
npm run start:dev

# 🌎 Open the URL
open http://localhost:9000

πŸ“‚ Folder Structure

β”œβ”€β”€ build                       # Tooling
β”‚   β”œβ”€β”€ coverage                  # Code coverage reports
β”‚   β”œβ”€β”€ cypress                   # E2E / Integration testing
β”‚   β”œβ”€β”€ templates                 # Generator templates
β”‚   └── test                      # Unit tests / Jest + React Testing Library
β”‚
β”œβ”€β”€ public                      # Static assets served by Vercel CDN
β”‚   β”œβ”€β”€ manifest.json             # Use for SEO and PWA's
β”‚   β”œβ”€β”€ fonts                     # All of our font files
β”‚   └── images                    # Images used in the application
β”‚
β”œβ”€β”€ src                         # Application code
β”‚   β”œβ”€β”€ __test__                  # Tests for our "pages" directory
β”‚   β”œβ”€β”€ components                # --- bit of a GOD folder ---
β”‚   β”œβ”€β”€ config                    # Configuration broken up into small pieces
β”‚   β”œβ”€β”€ generated                 # πŸ€– Generated code, typings and React Hooks
β”‚   β”œβ”€β”€ graphql                   # Queries and mutations as ".graphql"
β”‚   β”œβ”€β”€ hooks                     # React hooks for our application
β”‚   β”œβ”€β”€ pages                     # Each route is inherently defined here
β”‚   β”œβ”€β”€ recoil                    # RecoilJS is used for "local state"
β”‚   β”œβ”€β”€ routes                    # Folder structure that maps to our "pages"
β”‚   β”œβ”€β”€ services                  # Think "tracking" and "global" or "application"
β”‚   β”œβ”€β”€ styles                    # Application CSS and "@barguide/style-guide"
β”‚   β”œβ”€β”€ types                     # TypeScript Types
β”‚   └── utils                     # Utilities used throughout the app
β”‚...