https://github.com/ml-opensource/nextjs-starter
A pretty opinionated nextjs starter app w/ typescript
https://github.com/ml-opensource/nextjs-starter
Last synced: 7 months ago
JSON representation
A pretty opinionated nextjs starter app w/ typescript
- Host: GitHub
- URL: https://github.com/ml-opensource/nextjs-starter
- Owner: ml-opensource
- Created: 2018-03-24T23:02:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-26T14:41:19.000Z (almost 8 years ago)
- Last Synced: 2024-05-07T16:46:46.905Z (almost 2 years ago)
- Language: TypeScript
- Size: 71.3 KB
- Stars: 4
- Watchers: 23
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NextJS Starter
### General
A pretty opinionated TypeScript React/Redux Next.js starter application.
### Installation
0. Install [`Yarn`](https://yarnpkg.com/en/) and [`TypeScript`](https://www.typescriptlang.org)
1. Install the project dependencies:
`yarn install`
2. Start the development server:
`yarn dev`
### Project Organization
All Components are sorted into 2 directories:
- Components that represent "Pages" (i.e. base component for a route) are stored in the `/pages` directory. Routing in Next.js is based on the file system, so `./pages/index.js` maps to the `/` route and `./pages/about.js` would map to `/about`.
The `./static` directory maps to `/static` in the `next` server, so you can put all your
other static resources like images or compiled CSS in there.
- Components that can be used throughout the app as global components or components that serve as wrappers or Higher Order components are stored in the `/components` directory.
## Data Flow
Uses Redux/Sagas.
## Styling
Uses StyledComponents.
## Bootstrap Skeleton
This project was bootstrapped with [Create Next App](https://github.com/segmentio/create-next-app).
Find the most recent version of this guide at [here](https://github.com/segmentio/create-next-app/blob/master/lib/templates/default/README.md). And check out [Next.js repo](https://github.com/zeit/next.js) for the most up-to-date info.