Skip to content

Latest commit

 

History

History
118 lines (82 loc) · 6.32 KB

README.md

File metadata and controls

118 lines (82 loc) · 6.32 KB
Raw

react-next-boilerplate

We spend time using good community practices to make your project scalable.

🚀 A basis for reducing the configuration of your projects with Next.js, best development practices and popular libraries in the developer community.

Features

  • redux-saga: A library that aims to make application side effects (i.e. asynchronous things like data fetching and impure things like accessing the browser cache) easier to manage, more efficient to execute, easy to test, and better at handling failures.
  • redux-saga-routines: A smart action creator for Redux. Useful for any kind of async actions like fetching data. Also fully compatible with Redux Saga and Redux Form.
  • next-i18next: A plugin for Next.js projects that allows you to get translations up and running quickly and easily, while fully supporting SSR, multiple namespaces with code splitting, etc.
  • i18next: An internationalization-framework written in and for JavaScript. But it's much more than that.
  • redux: A predictable state container for JavaScript apps.
  • reselect: Simple selector library for Redux (and others) inspired by getters in NuclearJS, subscriptions in re-frame and this proposal from speedskater.
  • Immer: (German for: always) is a tiny package that allows you to work with immutable state in a more convenient way. It is based on the copy-on-write mechanism
  • @testing-library/react: Simple and complete React DOM testing utilities that encourage good testing practices.
  • SEO: The advantages of this approach is to be able to create Rich User experiences in a uniform way, without compromising Search Engine Optimisation (SEO) factors that are key to good ranking on Google and other search engines.
  • Typefaces: Self-hosting is significantly faster. Loading a typeface from Google Fonts or other hosted font service adds an extra (blocking) network request.
  • Emotion: A library designed for writing css styles with JavaScript. It provides powerful and predictable style composition in addition to a great developer experience with features such as source maps, labels, and testing utilities.

Getting Started

Welcome to the light documentation of React Next Boilerplate!

System Requirements

  • Node.js 10 or later
  • MacOS, Windows (including WSL), and Linux are supported

Setup

  1. Clone this repo using git clone --depth=1 https://github.com/react-next-boilerplate/react-next-boilerplate.git <YOUR_PROJECT_NAME>
  2. Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
  3. Run yarn or npm install to install dependencies .
  4. Run yarn dev or npm run dev to see the example app at http://localhost:3000.

These scripts refer to the different stages of developing an application:

  • dev - Runs next which starts Next.js in development mode
  • build - Runs next build which builds the application for production usage
  • start - Runs next start which starts a Next.js production server

Now you're ready to rumble! 🚥

Documentation

  • Commands: Getting the most out of this boilerplate

Demo

Code of Conduct

React Next Boilerplate is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the React Next Boilerplate community to abide by our Code of Conduct. Please read it. Please follow it. In the React Next Boilerplate community, we work hard to build each other up and create amazing things together.

Contributing

Thank you for your interest in contributing; we are delighted you want to help out. We have a contributing guide to help you get started.

License

This project is licensed under the MIT license, Copyright (c) 2019 Jorge Luis Calleja Alvarado. For more information see project license.

Authors