inbn / isitaccessible-nextjs

Home Page:isitaccessible.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Is it accessible?

Local setup

  1. Generate a new Personal Access Token from your GitHub account.
  2. Duplicate .env.example and call it .env. Add your GITHUB_API_TOKEN.

Styling

Sass is used for styling. There are two types of styles used in the app:

  1. Global styles: These live in the ./styles folder in the root of the app and apply globally. Use these for CSS resets, global variables, and generic element styles. e.g. headings, lists.

  2. Component styles: These live alongside each component and use CSS modules (with SCSS syntax). The filename format is: <component_name>.module.scss. e.g. SearchForm.module.scss. Class names from the CSS module are automatically rewritten to be locally scoped. Instead of using hyphens in class names, use camelCase.

Icons

Use the Icon component for rendering icons. To add a new icon, place it in the icons directory then run the command, npm run generate-svg-sprite. The name prop passed to the Icon component should match the name of the original SVG file. e.g. to render the icon, search.svg:

<Icon name="search" />

Readme from Create-next-app

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.tsx.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

isitaccessible.vercel.app


Languages

Language:TypeScript 70.7%Language:SCSS 26.5%Language:JavaScript 2.6%Language:Shell 0.2%