Nodejs.dev

Nodejs.dev site built using Gatsby.js with React.js, TypeScript, Emotion, and Remark.

You can find the latest Figma design protype here.

🚀 Get Started

Install Yarn (if Yarn Package Manager is not available on your machine).

Yarn has an installation guide for your specific configuration. Happy knitting!
Install dependencies.
```
# install the dependencies
yarn install
```
Start developing.
```
# "start": "gatsby develop"
yarn start
```
Open the source code and start editing!

Your site is now running at http://localhost:8000!

Note: You'll also see a second link: http://localhost:8000___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .nvmrc
├── .prettierrc
├── empty.env
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
├── README.md
├── tsconfig.json
├── tslint.json
└── yarn.lock

/node_modules: The directory where all of the modules of code that your project depends on (npm packages) are automatically installed.
/src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser), like your site header, or a page template. “Src” is a convention for “source code.”
.gitignore: This file tells git which files it should not track/not maintain a version history.
.nvmrc: NVM configuration so packages work as they should
.prettierrc: This is a configuration file for a tool called Prettier, which is a tool to help keep the formatting of your code consistent.
empty.env: Rename to .env and set your Contentful API key
gatsby-browser.tsx: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.
gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).
gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
gatsby-ssr.tsx: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.
LICENSE: Gatsby is licensed under the MIT license.
package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).
package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc.). This manifest is how npm knows which packages to install for your project.
README.md: A text file containing useful reference information about your project.
tsconfig.json: Config file for TypeScript
tslint.json: TS Lint configuration file
yarn.lock: Yarn is a package manager alternative to npm. You can use either yarn or npm, though all of the Gatsby docs reference npm. This file serves essentially the same purpose as package-lock.json, just for a different package management system.

📝 Data Sources

This repository contains no documentation content. Content is pulled from across the Node.js Github Org, Contentful, and other data sources and stitched together into a cohesive website.

src/documentation

The src/documentation directory currently contains all the getting started content.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
To dive straight into code samples head to our documentation. In particular, check out the “Guides”, API reference, and “Advanced Tutorials” sections in the sidebar.

🏛 Governance

This initiative adopts the general Node.js Code of Conduct, as well as its own Contributing Guidelines.

Meetings

Meeting notes from past meetings are maintained for later reference. Query issues for "Meeting" to find future meetings.

Summary / Current Status

Our current focus is on site development. Development is happening in the nodejs.dev repo. This repo continues to be the hub for the redesign initiative.

Team

@nodejs/website-redesign

Any person who wants to contribute to the initiative is welcome! Please read Contributing Guidelines and join the effort 🙌.

Any member of the website-redesign initiative attached to the current phase of the project will be added to a future phase as the project moves forward.

Any member of the website-redesign initiative who prefers to begin contributing at a specific future phase is welcome to make a PR adding their handle to that phase.

@amiller-gh - Adam Miller, CommComm Co-champion
@chowdhurian - Manil Chowdhury, CommComm Co-champion

Information Gathering

@amiller-gh - Adam Miller
@codeekage - Agiri Abraham JNR
@darcyclarke - Darcy Clarke
@maddhruv - Dhruv Jain
@fhemberger - Frederic Hemberger
@JonahMoses - Jonah Moses
@chowdhurian - Manil Chowdhury
@oe - Olivia Hugger
@bnb - Tierney Cyren
@timothyis - Timothy

IA / UX Planning

@oe - Olivia Hugger
@fhemberger - Frederic Hemberger
@bnb - Tierney Cyren
@timothyis - Timothy
@JonahMoses - Jonah Moses
@amiller-gh - Adam Miller
@emilypmendez - Emily Mendez
@darcyclarke - Darcy Clarke
@maddhruv - Dhruv Jain
@chowdhurian - Manil Chowdhury
@codeekage - Agiri Abraham JNR
@add1sun - Addison Berry
@Qard - Stephen Belanger
@watilde - Daijiro Wachi
@tolmasky - Francisco Ryan Tolmasky I
@milapbhojak - Milap Bhojak
@devamaz - Ahmad Abdul-Aziz

UI Design and Content Creation

@amiller-gh - Adam Miller
@bnb - Tierney Cyren
@codeekage - Agiri Abraham JNR
@chowdhurian - Manil Chowdhury
@maddhruv - Dhruv Jain
@milapbhojak - Milap Bhojak
@tolmasky - Francisco Ryan Tolmasky I
@iNidAName - Hassaan Sani
@abedzantout - Abdul Rahman Zantout
@AliObaji - Ali Obaji
@AhmadAwais - AhmadAwais

Links

Community Committee Code of Conduct Contributing Guidelines Meeting Notes Query issues for "Meeting"

Name		Name	Last commit message	Last commit date
Latest commit History 199 Commits
.github		.github
meetings		meetings
src		src
style-guide		style-guide
test		test
.editorconfig		.editorconfig
.firebaserc		.firebaserc
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierignore		.prettierignore
.prettierrc		.prettierrc
.travis.yml		.travis.yml
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
ModerationPolicy.md		ModerationPolicy.md
README.md		README.md
cloudbuild-deploy.yaml		cloudbuild-deploy.yaml
cloudbuild.yaml		cloudbuild.yaml
commitlint.config.js		commitlint.config.js
empty.env		empty.env
firebase.json		firebase.json
gatsby-config.js		gatsby-config.js
gatsby-node.js		gatsby-node.js
package.json		package.json
test-preprocessor.js		test-preprocessor.js
test-setup.js		test-setup.js
tsconfig.json		tsconfig.json
tslint.json		tslint.json
yarn.lock		yarn.lock

License

ogonzal87/nodejs.dev

Folders and files

Latest commit

History

Repository files navigation

🚀 Get Started

🧐 What's inside?

📝 Data Sources

src/documentation

🎓 Learning Gatsby

🏛 Governance

Meetings

Summary / Current Status

Team

Information Gathering

IA / UX Planning

UI Design and Content Creation

Site Development <-- current phase

Links

About

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages