gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated getting started guide

Browse Source
This commit is contained in:
Sahat Yalkabov
2014-01-26 20:08:22 -05:00
parent bba884cfc8
commit e9604362de
1 changed files with 20 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -33,27 +33,34 @@ Prerequisites
> - **Xcode** (Mac OS X) or **Visual Studio** (Windows) > - **Xcode** (Mac OS X) or **Visual Studio** (Windows)
Quick Start Getting Started
----------- ---------------
Git clone: `git clone --depth=1 git@github.com:sahat/hackathon-starter.git`
**Note**: The depth=1 specifies to clone only the latest revision, instead of cloning the entire repo with full history.
[Download the latest release](https://github.com/sahat/hackathon-starter/releases). The easiest way to get started is to clone the repository:
Then follow these commands to install third-party library dependencies and start the server. ```bash
# Fetch only the latest commits.
git clone --depth=1 git@github.com:sahat/hackathon-starter.git
``` # Move the repository to your own project name.
cd hackathon-starter-1.0 mv hackathon-starter my-project
cd my-project
# Install NPM dependencies
npm install npm install
node app.js node app.js
``` ```
**Note**: I highly recommend installing nodemon `sudo npm install -g nodemon`. > **Note**: I strongly recommend installing nodemon `sudo npm install -g nodemon`.
It will monitor for any changes in your node.js > It will monitor for any changes in your node.js
application and automatically restart the server. Once installed, instead of `node app.js` use `nodemon app.js`. > application and automatically restart the server. Once installed, instead of `node app.js` use `nodemon app.js`.
> It will be a huge time saver.
Next, if you want to use any of the APIs or OAuth2 authentication methods, you will need to obtain Next up, if you want to use any of the APIs or OAuth2 authentication methods, you will need to obtain
appropriate ClientID/ClientSecret, API Key, or Username/Password. appropriate credentials: Client ID, Client Secret, API Key, or Username & Password. You will
need to go through each provider to generate new credentials.
Obtaining API Keys Obtaining API Keys
------------------ ------------------