-
Notifications
You must be signed in to change notification settings - Fork 21
Updated & Restructured Dev Docs, Updated Footer and Sidebar #352
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,4 +4,5 @@ _site/ | |
.jekyll-metadata | ||
.DS_Store | ||
.vscode | ||
vendor/ | ||
*.*~ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
--- | ||
title: "Project Setup: Extra Installations" | ||
sidebar-title: "Project Setup" | ||
--- | ||
|
||
# Project Setup: Extra Installations | ||
{:.no_toc} | ||
|
||
So, you want to work on our cool projects like the Editor or a Learning Lab! We're excited to have you on our team, but there's a few things you have to setup before you can jump right into working on our projects! | ||
|
||
## Table of Contents | ||
{:.no_toc} | ||
* TOC | ||
{:toc} | ||
|
||
## Initial Setup | ||
|
||
First, make sure that you have setup your GitHub account and Git on your machine by following the first steps of our [dev setup guide]({{ site.baseurl }}/docs/dev-setup). | ||
|
||
Our projects require a few more things we have to set-up as well, so be sure to head back to this page once you've set-up git and GitHub! | ||
|
||
## Installing node and npm | ||
|
||
For our projects, we use JavaScript and Typescript to handle website logic, so we'll also need package managers to handle all our JavaScript dependencies. There are two primary package managers that we use, the first being the Node Package Manager, or npm. npm actually comes with `Node.js`, a JavaScript tool that we also need which is used to help build network applications, so let's check if we have it installed already! | ||
|
||
Try running: | ||
|
||
```sh | ||
$ node -v | ||
``` | ||
|
||
If you already have node installed in your machine, you should see some | ||
numbers in the form of `vXX.XX.X` which means that you already have node (and consequently npm) installed, and don't need to do anything else! | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Might want to add something about There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, we should probably mention something about using the right node version - esp with node 16, it really does matter which version they install. |
||
|
||
If you see something along the lines of | ||
|
||
``` | ||
command not found: node | ||
``` | ||
|
||
then you should follow the instructions on node's official site [here](https://nodejs.org/en/download/) to get it installed. | ||
|
||
If you use WSL instead, you can follow these special instructions [here](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl). | ||
|
||
To check that node has been properly installed on your machine, just run: | ||
|
||
```sh | ||
$ node -v | ||
``` | ||
|
||
Comment on lines
+47
to
+52
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this duped? |
||
And you should be all set for using npm! | ||
|
||
## Installing yarn | ||
|
||
The second package manager that we use for our projects, `yarn`, is another application manager similar to npm that was launched by Facebook in 2016! A lot of developers prefer yarn over npm due to its improved performance and speed. If you want to see the major differences between yarn and npm, you can check out this [article](https://www.whitesourcesoftware.com/free-developer-tools/blog/npm-vs-yarn-which-should-you-choose/) on it. | ||
|
||
First, check to see if you have yarn already installed by running | ||
|
||
```sh | ||
$ yarn --version | ||
``` | ||
|
||
If you get numbers in the form of `X.XX.XX` then you have yarn already installed and are good to go! | ||
|
||
Otherwise, if you get | ||
|
||
``` | ||
command not found: yarn | ||
``` | ||
|
||
then we can actually install yarn with our trusty npm that we just installed above! | ||
|
||
After running: | ||
|
||
```sh | ||
$ npm install --global yarn | ||
``` | ||
|
||
you can check if you have yarn properly installed by running | ||
|
||
```sh | ||
$ yarn --version | ||
``` | ||
|
||
And you should be all set for using yarn! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should explicitly mention Node somewhere, since not all of our projects are in node (i.e., if someone starts on the website, it's a project!).