https://github.com/joncursi/next-base

⏭️ Base setup for a Next.js front-end.
https://github.com/joncursi/next-base

circleci commitlint eslint express fastlane jest material-ui nextjs prettier react typescript

Last synced: about 2 months ago
JSON representation

⏭️ Base setup for a Next.js front-end.

• Host: GitHub
• URL: https://github.com/joncursi/next-base
• Owner: joncursi
• License: mit
• Created: 2020-02-04T00:16:35.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T23:15:14.000Z (about 2 years ago)
• Last Synced: 2023-07-25T22:23:30.202Z (over 1 year ago)
• Topics: circleci, commitlint, eslint, express, fastlane, jest, material-ui, nextjs, prettier, react, typescript
• Language: TypeScript
• Homepage: https://next-base-gujktyvbpa.now.sh/
• Size: 1.32 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Next Base

⏭️ Base setup for a [Next.js](https://nextjs.org/) front-end. Includes:

* [Next Routes](https://github.com/fridays/next-routes) for dynamic routing

* [Dotenv CLI](https://github.com/entropitor/dotenv-cli) for environment

variables

* [TypeScript](https://www.typescriptlang.org/) as the language

* [Express](https://expressjs.com/) as the server

* [Material UI](https://material-ui.com/) as the design system

* [Styled JSX](https://github.com/zeit/styled-jsx) for CSS in JS

* [Jest](https://jestjs.io/) as the test runner

* [Snapshots](https://jestjs.io/docs/en/snapshot-testing) for component unit

testing

* [ESLint](https://eslint.org/) for code linting (via

[`@joncursi/eslint-config`](https://github.com/joncursi/eslint-config))

* [CommitLint](https://commitlint.js.org/) for commit linting (via

[`@joncursi/eslint-config`](https://github.com/joncursi/eslint-config))

* [Prettier](https://prettier.io/) for code formatting (via

[`@joncursi/eslint-config`](https://github.com/joncursi/eslint-config))

* [Fastlane](https://fastlane.tools/) for release management

* [Now](https://zeit.co/) for deployments

[![CircleCI](https://circleci.com/gh/joncursi/next-base.svg?style=shield)](https://circleci.com/gh/joncursi/next-base)

## Getting Started

1. Install node modules:

    ```shell

    npm install

    ```

2. Create a `.env` file in the root of this project and fill it with

[environment variables](https://github.com/joncursi/next-base/blob/master/.env.example).

3. Start the server in dev mode:

    ```shell

    npm run dev

    ```

4. Start the server in production mode:

    ```shell

    npm run build

    npm start

    ```

## npm Scripts

There are lots of npm scripts at your disposal during local development.

Here are some of the more important ones:

| Script                 | Description                                            |

|:---------------------- |:------------------------------------------------------ |

| npm run analyze        | Shows interactive visualization of the webpack bundle. |

| npm run dev            | Starts the local dev server.                           |

| npm run build          | Builds a production distribution.                      |

| npm start              | Starts the server in production mode.                  |

| npm test               | Run all tests.                                         |