Skip to content

Commit 10d80c4

Browse files
sdrassdras
committed
create coc, license, update copy, update gitignore
1 parent 61f5087 commit 10d80c4

File tree

4 files changed

+240
-41
lines changed

4 files changed

+240
-41
lines changed

Diff for: ‎.gitignore

+140
Original file line numberDiff line numberDiff line change
@@ -1 +1,141 @@
1+
### Node ###
2+
# Logs
3+
logs
4+
*.log
5+
npm-debug.log*
6+
yarn-debug.log*
7+
yarn-error.log*
8+
lerna-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
142
node_modules/
43+
jspm_packages/
44+
45+
# TypeScript v1 declaration files
46+
typings/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Microbundle cache
58+
.rpt2_cache/
59+
.rts2_cache_cjs/
60+
.rts2_cache_es/
61+
.rts2_cache_umd/
62+
63+
# Optional REPL history
64+
.node_repl_history
65+
66+
# Output of 'npm pack'
67+
*.tgz
68+
69+
# Yarn Integrity file
70+
.yarn-integrity
71+
72+
# dotenv environment variables file
73+
.env
74+
.env.test
75+
.env*.local
76+
77+
# parcel-bundler cache (https://parceljs.org/)
78+
.cache
79+
.parcel-cache
80+
81+
# Next.js build output
82+
.next
83+
84+
# Nuxt.js build / generate output
85+
.nuxt
86+
dist
87+
88+
# Gatsby files
89+
.cache/
90+
# Comment in the public line in if your project uses Gatsby and not Next.js
91+
# https://nextjs.org/blog/next-9-1#public-directory-support
92+
# public
93+
94+
# vuepress build output
95+
.vuepress/dist
96+
97+
# Serverless directories
98+
.serverless/
99+
100+
# FuseBox cache
101+
.fusebox/
102+
103+
# DynamoDB Local files
104+
.dynamodb/
105+
106+
# TernJS port file
107+
.tern-port
108+
109+
# Stores VSCode versions used for testing VSCode extensions
110+
.vscode-test
111+
112+
### OSX ###
113+
# General
114+
.DS_Store
115+
.AppleDouble
116+
.LSOverride
117+
118+
# Icon must end with two \r
119+
Icon
120+
121+
122+
# Thumbnails
123+
._*
124+
125+
# Files that might appear in the root of a volume
126+
.DocumentRevisions-V100
127+
.fseventsd
128+
.Spotlight-V100
129+
.TemporaryItems
130+
.Trashes
131+
.VolumeIcon.icns
132+
.com.apple.timemachine.donotpresent
133+
134+
# Directories potentially created on remote AFP share
135+
.AppleDB
136+
.AppleDesktop
137+
Network Trash Folder
138+
Temporary Items
139+
.apdisk
140+
141+
# End of https://www.toptal.com/developers/gitignore/api/osx,node

Diff for: ‎CODE_OF_CONDUCT.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Code of Conduct
2+
3+
## 1. Purpose
4+
5+
A primary goal of Next on Netlify Build Plugin is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
6+
7+
This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
8+
9+
We invite all those who participate in Next on Netlify Build Plugin to help us create safe and positive experiences for everyone.
10+
11+
## 2. Open Source Citizenship
12+
13+
A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
14+
15+
Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
16+
17+
If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
18+
19+
## 3. Expected Behavior
20+
21+
The following behaviors are expected and requested of all community members:
22+
23+
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
24+
- Exercise consideration and respect in your speech and actions.
25+
- Attempt collaboration before conflict.
26+
- Refrain from demeaning, discriminatory, or harassing behavior and speech.
27+
- Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
28+
- Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
29+
30+
## 4. Unacceptable Behavior
31+
32+
The following behaviors are considered harassment and are unacceptable within our community:
33+
34+
- Violence, threats of violence or violent language directed against another person.
35+
- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
36+
- Posting or displaying sexually explicit or violent material.
37+
- Posting or threatening to post other people’s personally identifying information ("doxing").
38+
- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
39+
- Inappropriate photography or recording.
40+
- Inappropriate physical contact. You should have someone’s consent before touching them.
41+
- Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
42+
- Deliberate intimidation, stalking or following (online or in person).
43+
- Advocating for, or encouraging, any of the above behavior.
44+
- Sustained disruption of community events, including talks and presentations.
45+
46+
## 5. Consequences of Unacceptable Behavior
47+
48+
Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
49+
50+
Anyone asked to stop unacceptable behavior is expected to comply immediately.
51+
52+
If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
53+
54+
## 6. Reporting Guidelines
55+
56+
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. [email protected]
57+
58+
Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
59+
60+
## 7. Addressing Grievances
61+
62+
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify sdras with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
63+
64+
## 8. Scope
65+
66+
We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
67+
68+
This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
69+
70+
## 9. Contact info
71+
72+
[email protected]
73+
74+
## 10. License and attribution
75+
76+
This Code of Conduct is distributed under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
77+
78+
Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
79+
80+
Retrieved on October 26, 2020 from [http://citizencodeofconduct.org/](http://citizencodeofconduct.org/)

Diff for: ‎LICENSE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2020 Netlify, Inc.
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Diff for: ‎README.md

+13-41
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,17 @@
11
![Next.js on Netlify Build Plugin](nextonnetlify.png)
22

3-
<p align="center">
4-
<a aria-label="npm version" href="https://www.npmjs.com/package/next-on-netlify">
5-
<img alt="" src="https://img.shields.io/npm/v/next-on-netlify">
6-
</a>
7-
<a aria-label="MIT License" href="https://img.shields.io/npm/l/next-on-netlify">
8-
<img alt="" src="https://img.shields.io/npm/l/next-on-netlify">
9-
</a>
10-
<a aria-label="npm downloads" href="https://www.npmjs.com/package/next-on-netlify">
11-
<img alt="" src="https://img.shields.io/npm/dt/next-on-netlify">
12-
</a>
13-
<a aria-label="Tested with Cypress" href="https://www.cypress.io/">
14-
<img alt="" src="https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg">
15-
</a>
16-
</p>
17-
18-
19-
`next-on-netlify` is a utility for enabling server-side rendering in Next.js on Netlify. It wraps your application in a tiny compatibility layer, so that pages can use Netlify Functions to be server-side rendered.
3+
# Next on Netlify Build Plugin
204

21-
**TL;DR: You can enable SSR in your Next.js applications with 3 simple steps, listed [here](#setup)!**
5+
This build plugin is a utility for enabling server-side rendering in Next.js on Netlify. It wraps your application in a tiny compatibility layer, so that pages can use Netlify Functions to be server-side rendered.
226

23-
- Demo: https://next-on.netlify.com/
24-
- Example repository: https://github.com/netlify-labs/next-on-netlify-demo
7+
**TL;DR: You can enable SSR in your Next.js applications with 3 simple steps, listed [here](#setup)!**
258

269
## Table of Contents
2710

28-
- [Installation](#installation)
11+
- [Installation and Configuration](#installation-and-configuration)
2912
- [Setup](#setup)
3013
- [1. Set Next.js target to serverless](#1-set-nextjs-target-to-serverless)
3114
- [2. Add postbuild hook](#2-add-postbuild-hook)
32-
- [3. Configure Netlify](#3-configure-netlify)
3315
- [Optional Extras](#optional-extras)
3416
- [Preview Locally](#preview-locally)
3517
- [Custom Netlify Redirects](#custom-netlify-redirects)
@@ -40,11 +22,15 @@
4022
- [Credits](#credits)
4123
- [Showcase](#showcase)
4224

25+
## Installation and Configuration
4326

44-
## Installation
27+
Create a `netlify.toml`:
4528

46-
```
47-
npm install --save next-on-netlify
29+
```toml
30+
[build]
31+
command = "npm run build"
32+
functions = "out_functions"
33+
publish = "out_publish"
4834
```
4935

5036
## Setup
@@ -61,7 +47,7 @@ It's super simple. Just create a `next.config.js` file and write the following:
6147
module.exports = {
6248
// Target must be serverless
6349
target: "serverless",
64-
};
50+
}
6551
```
6652

6753
If binaries are needed in the deployment the following configuration is needed ([Prisma](https://github.com/prisma/prisma) is an example):
@@ -73,7 +59,7 @@ module.exports = {
7359
// Target must be experimental-serverless-trace
7460
// Your build time will be longer with this option
7561
target: "experimental-serverless-trace",
76-
};
62+
}
7763
```
7864

7965
#### 2. Add postbuild hook
@@ -96,17 +82,6 @@ We want the next-on-netlify command to run after we build our NextJS application
9682

9783
\*If you're curious about the "magic", check out the well-documented [`next-on-netlify.js` file](https://github.com/netlify/next-on-netlify/blob/master/next-on-netlify.js).
9884

99-
#### 3. Configure Netlify
100-
101-
We're almost done! We just have to tell Netlify how to build our Next.js app, where the functions folder is located, and which folder to upload to its CDN. We do that with a `netlify.toml` file and the following instructions:
102-
103-
```toml
104-
[build]
105-
command = "npm run build"
106-
functions = "out_functions"
107-
publish = "out_publish"
108-
```
109-
11085
We're done. Let's deploy 🚀🚀🚀
11186

11287
## Optional Extras
@@ -187,7 +162,6 @@ With `next-on-netlify`, when navigating to a path that is not defined in `getSta
187162

188163
For more on this, see: [Issue #7](https://github.com/netlify/next-on-netlify/issues/7#issuecomment-636883539)
189164

190-
191165
## Credits
192166

193167
This package is maintained by [Lindsay Levine](https://github.com/lindsaylevine), [Finn Woelm](https://github.com/FinnWoelm), and [Cassidy Williams](https://github.com/cassidoo).
@@ -206,7 +180,6 @@ This package is maintained by [Lindsay Levine](https://github.com/lindsaylevine)
206180
- [@jonasbuntinx](https://github.com/jonasbuntinx)
207181
- [@joostmeijles](https://github.com/joostmeijles)
208182

209-
210183
## Showcase
211184

212185
The following sites are built with `next-on-netlify`:
@@ -218,4 +191,3 @@ The following sites are built with `next-on-netlify`:
218191
[missionbit.org](https://www.missionbit.org/) ([#18](https://github.com/netlify/next-on-netlify/pull/18#issuecomment-643828966))
219192

220193
Are you building something awesome with `next-on-netlify`? 🔥 Let us know and we will feature it here :)
221-

0 commit comments

Comments
 (0)