adrienjoly/sample-project-readme.md

Created April 29, 2015 15:08

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/adrienjoly/ea66cfee5529d376dccb.js"></script>
Save adrienjoly/ea66cfee5529d376dccb to your computer and use it in GitHub Desktop.

Download ZIP

(Sample) Project Readme.md

Raw

sample-project-readme.md

(Sample) Project Readme.md

Prerequisites

Install Git
Setup Git
Install Node.js version X.XX.XX
Install MongoDB version X.XX.XX

Project setup

Clone git repo
Run npm install
Create a MongoDB database: mongod --dbpath ./data
Initialize the DB: mongo initdb.js

Project startup

Make sure that MongoDB is running, or mongod --dbpath ./data
Run npm start
Go to localhost:8080

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment