Skip to content

Commit

Permalink
v1.2.0-canary (#44)
Browse files Browse the repository at this point in the history
* [core]: Update packages

* [core]: Add tests to IndexPage

* [core]: Removed config to @zeit/next-css and url-loader

* [travis]: Add stage test

* [docs]: Update preview

* [core]: Add and use immer

* [docs]: Add doc immer and remove steps in travis

* Browserconfig (#39)

* [browserconfig]: Add some favicon versions

* [browserconfig]: Add config browser to document page

* [docs]: Add doc to Setup

* [docs]: Add emoji 🚥

* Fix titile

* [docs]: Add CODE_OF_CONDUCT.md and commands.md (#41)

* [core]: Unused packages removed (#43)

* Create FUNDING.yml
  • Loading branch information
wootsbot committed Feb 10, 2020
1 parent c569db1 commit 0678e66
Show file tree
Hide file tree
Showing 33 changed files with 1,967 additions and 1,428 deletions.
12 changes: 12 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: wootsbot
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
17 changes: 4 additions & 13 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,9 @@ node_js:
install:
- yarn

jobs:
include:
- stage: dependencies
script:
- yarn

- stage: prettier
script:
- yarn prettier

- stage: lint
script:
- yarn lint
script:
- yarn prettier
- yarn lint
- yarn test

after_success: 'yarn coveralls'
50 changes: 50 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# React Next Boilerplate Contributor Covenant Code of Conduct

We really like React and some things that we think is excellent is its community.

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience,nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our standards

Creating a positive environment implies:

- Using welcoming and inclusive language.
- Being respectful towards differing viewpoints and experiences.
- Gracefully accepting constructive criticism.
- Focusing on what is best for the community.
- Showing empathy towards other community members.

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances.
- Trolling, insulting/derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others’ private information, such as a physical or electronic address, without explicit permission.
- Other conduct which could reasonably be considered inappropriate in a professional setting.

## Our responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this code of conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [jorgelca1205@gmail.com](jorgelca1205@gmail.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

When faced with repeated bad faith comments or harassment after an earnest attempt to mediate an issue, the Gatsby team reserves the right to remove someone from the GitHub repository and/or block them on social media. This decision will always be made with consensus from more than one team member.

## Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4.

- homepage: https://contributor-covenant.org
- version: https://contributor-covenant.org/version/1/4/
32 changes: 6 additions & 26 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,18 @@
# Thanks for being interested in contributing! We're so glad you want to help!

Below you'll find guides on the `react-next-boilerplate` community, code of conduct, and how to get started with contributing:
Below you'll find guides on the `react-next-boilerplate` community, and how to get started with contributing:

We really like React and some things that we think is excellent is its community, so I would like to use some [Gatsby Contributor Covenant Code of Conduct](https://www.gatsbyjs.org/contributing/code-of-conduct/).

## Our standards

Creating a positive environment implies:

- Using welcoming and inclusive language.
- Being respectful towards differing viewpoints and experiences.
- Gracefully accepting constructive criticism.
- Focusing on what is best for the community.
- Showing empathy towards other community members.

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances.
- Trolling, insulting/derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others’ private information, such as a physical or electronic address, without explicit permission.
- Other conduct which could reasonably be considered inappropriate in a professional setting.

## Our responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this code of conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## How to contribute

Feel free to contribute whatever you want by creating issues to improve the source code, contributing ideas to create a better community.

### Opening PRs in react-next-boilerplate
## Not sure how to start contributing?

If you are worried or don’t know where to start. You can reach out with questions to [Jorge L. C. A. (@wootsbot)](https://twitter.com/wootsbot) or [ @RNBoilerplate](https://twitter.com/RNBoilerplate) on Twitter, and anyone from the react-next-boilerplate team on [spectrum](https://spectrum.chat/react-next-boilerplate).

## Opening PRs in react-next-boilerplate

To test reaction-native-polyline-address changes and project files locally,
you can fork the repository and install parts to run it on your local machine
Expand Down
62 changes: 42 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![react-next-boilerplate](./docs/images/Preview.png)](https://github.com/react-next-boilerplate/react-next-boilerplate)
[![react-next-boilerplate](./docs/images/preview-v2.png)](https://github.com/react-next-boilerplate/react-next-boilerplate)

<br />

Expand All @@ -13,9 +13,7 @@
<img src="https://img.shields.io/travis/react-next-boilerplate/react-next-boilerplate?style=flat-square" alt="Build Status" />
</a>
<!-- Test Coverage -->
<a href="https://coveralls.io/github/react-next-boilerplate/react-next-boilerplate">
<img src="https://img.shields.io/coveralls/github/react-next-boilerplate/react-next-boilerplate?style=flat-square" alt="Test Coverage" />
</a>
<a href='https://coveralls.io/github/react-next-boilerplate/react-next-boilerplate?branch=canary'><img src='https://coveralls.io/repos/github/react-next-boilerplate/react-next-boilerplate/badge.svg?branch=canary' alt='Coverage Status' /></a>

<!-- Quality -->
<a href="https://app.codacy.com/manual/react-next-boilerplate/react-next-boilerplate/dashboard?bid=14562912">
Expand Down Expand Up @@ -45,26 +43,50 @@

## 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.
- **next-i18next**: A plugin for [Next.js](https://nextjs.org/) 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](https://optimizely.github.io/nuclear-js/), subscriptions in re-frame and this proposal from speedskater.
- **@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.
- [x] **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.
- [x] **next-i18next**: A plugin for [Next.js](https://nextjs.org/) projects that allows you to get translations up and running quickly and easily, while fully supporting SSR, multiple namespaces with code splitting, etc.
- [x] **i18next**: An internationalization-framework written in and for JavaScript. But it's much more than that.
- [x] **redux**: A predictable state container for JavaScript apps.
- [x] **reselect**: Simple selector library for Redux (and others) inspired by getters in [NuclearJS](https://optimizely.github.io/nuclear-js/), subscriptions in re-frame and this proposal from speedskater.
- [x] **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
- [x] **@testing-library/react**: Simple and complete React DOM testing utilities that encourage good testing practices.
- [x] **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.
- [x] **Typefaces**: Self-hosting is significantly faster. Loading a typeface from Google Fonts or other hosted font service adds an extra (blocking) network request.
- [x] **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](https://nodejs.org/en/) 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! :traffic_light:

## Documentation

## Quick start
- [Commands](./docs/general/commands.md): Getting the most out of this boilerplate

1. Make sure that you have Node.js v8.15.1 and npm v5 or above installed.
2. Clone this repo using `git clone --depth=1 https://github.com/react-next-boilerplate/react-next-boilerplate.git <YOUR_PROJECT_NAME>`
3. Move to the appropriate directory: `cd <YOUR_PROJECT_NAME>`.
4. Run `npm start` to see the example app at `http://localhost:3000`.
## [Demo](https://react-next-boilerplate.herokuapp.com/en)

Now you're ready to rumble!
## Code of Conduct

### [Demo](https://react-next-boilerplate.herokuapp.com/en)
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](./CODE_OF_CONDUCT.md). 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

Expand Down
121 changes: 121 additions & 0 deletions docs/general/commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Command Line Commands

## Development

```Shell
yarn dev
```

or

```Shell
npm run dev
```

Starts the development server running on `http://localhost:3000`

## Server

### Development

```Shell
yarn dev
```

or

```Shell
npm run dev
```

Starts the development server and makes your application accessible at
`localhost:3000`. Changes in the application code will be hot-reloaded.

### Production

```Shell
yarn build && yarn start
```

or

```Shell
npm run build && npm run start
```

- `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

## Building

```Shell
yarn build
```

or

```Shell
npm run build
```

Preps your app for deployment (does not run tests). Optimizes and minifies all files, piping them to the `src/.next` folder.

## Unit testing

```Shell
yarn test
```

or

```Shell
npm run test
```

Tests your application with the unit tests specified in the `**/tests/*.js` files
throughout the application.

### Watching

```Shell
yarn test:watch
```

or

```Shell
npm run test:watch
```

Watches changes to your application and re-runs tests whenever a file changes.

## Linting

```Shell
yarn lint
```

or

```Shell
npm run lint
```

Lints your JavaScript.

## Prettier

```Shell
yarn prettier
```

or

```Shell
npm run prettier
```

Lints your JavaScript.

Lints your code and tries to fix any errors it finds.
Binary file added docs/images/preview-v2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ module.exports = {
collectCoverageFrom: [
'src/**/*.{js,jsx,mjs}',
'!src/pages/_*.js',
'!<rootDir>/src/pages/**',
'!coverage/**',
'!src/.next/**',
'!server/**',
Expand Down
2 changes: 1 addition & 1 deletion next-seo.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export default {
'A basis for reducing the configuration of your projects with nextJS, best development practices and popular libraries in the developer community.',
openGraph: {
url: 'https://github.com/react-next-boilerplate/react-next-boilerplate',
title: 'Chakra UI',
title: 'React Next Boilerplate',
description:
'A basis for reducing the configuration of your projects with nextJS, best development practices and popular libraries in the developer community.',
images: [
Expand Down
22 changes: 2 additions & 20 deletions next.config.js
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
const withCss = require('@zeit/next-css');

module.exports = withCss({
webpack(config) {
config.module.rules.push({
test: /\.(png|svg|eot|otf|ttf|woff|woff2)$/,
use: {
loader: 'url-loader',
options: {
limit: 100000,
publicPath: './',
outputPath: 'static/css',
name: '[name].[ext]',
},
},
});

return config;
},
module.exports = {
publicRuntimeConfig: {
localeSubpaths: typeof process.env.LOCALE_SUBPATHS === 'string' ? process.env.LOCALE_SUBPATHS : 'all',
},
});
};
Loading

0 comments on commit 0678e66

Please sign in to comment.