calebjacob / next

A starter repo for Next JS projects.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Next

A starter project ready to rock and roll!

Conventions

File structure based on: https://www.joshwcomeau.com/react/file-structure/

Styles structure based on: https://www.robinwieruch.de/styled-components

Getting Started

To get started, make sure you have NVM installed to manage your current version of Node and NPM:

brew install nvm

Once NVM has been installed, navigate to the project's root directory and run:

nvm install
nvm use

Now install all of the project's dependencies via NPM:

npm install

Finally, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result. Hot reloading is set up to pull in changes whenever code is modified.

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

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

About

A starter repo for Next JS projects.

License:MIT License


Languages

Language:TypeScript 86.2%Language:CSS 12.9%Language:JavaScript 0.9%