Abhay

.gitignore

@@ -1 +1,3 @@
 node_modules
+.vscode
+.env

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "parser": "flow",
+  "printWidth": 120,
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "none"
+}

README.md

@@ -30,6 +30,62 @@ I've collected usernames of amazing stargazers :star: in Github. By using Github
 
 You need to submit Github Token to access Github API.
 
+## Getting Started
+##### Pre-Installation Requirements
+###### Node
+- Download and install latest stable version of [Node](https://nodejs.org/en/download/). This app is tested on Node version v6.10.3
+
+###### MongoDb
+- Download and Install [MongoDB Community Edition] (https://docs.mongodb.com/manual/installation/#mongodb-community-edition). This app is tested on MongoDB version v3.4.1
+
+	- Create new data directory for mondoDB.
+      ```bash
+      mkdir -p </path/to/mongodb-data>
+      ```
+	- Run MongoDB
+      ```bash
+      mongod --dbpath </path/to/mongodb-data>
+      ```
+
+
+Now you should have mongoDB server running. If any issue please visit [mongoDB Doc](https://docs.mongodb.com/manual/installation/#tutorials). 
+
+Open another terminal/Command Prompt to clone this App.
+
+##### Installing and running curiosity
+
+```bash
+# Rest of the guide assumes you already have MongoDB installed and MongoDB server is running.
+
+# Get the latest version
+git clone https://github.com/curiositylab/curiosity
+
+# Change directory
+cd curiosity 
+
+# First time install only
+yarn install
+
+# Start the app
+yarn run start
+```
+If installation is successful You should see following message. visit 'http://localhost:3000' to view website.
+```
+NODE_ENV -> dev
+MONGODB_URI -> mongodb://127.0.0.1:27017/curiosity
+Starting server on port 3000.
+```
+
+Other Scripts for developement and testing.
+```bash
+# run test for the app
+yarn run test-node
+
+# Start app with watch (10s delay)
+yarn run watch
+```
+
+
 ## Tools I used
 
 * [SweetAlert2](https://limonte.github.io/sweetalert2/)

config/.test.env

@@ -0,0 +1,13 @@
+# Node ENV for TESTING
+# Update PRIVATE section below with correct value 
+# 
+# 
+#
+
+
+# Public section:-
+MONGODB_URI='mongodb://127.0.0.1:27017/curiosityTEST'
+
+
+
+# PRIVATE section:-

config/config.js

@@ -0,0 +1,12 @@
+require('dotenv').config();
+
+if (!process.env.NODE_ENV) {
+    process.env.NODE_ENV = 'dev';
+}
+
+const dotenv = require('dotenv').config({
+    path: `${__dirname}/.${process.env.NODE_ENV}.env`,
+});
+
+console.log('NODE_ENV ->', process.env.NODE_ENV);
+console.log('MONGODB_URI ->', process.env.MONGODB_URI);

config/sample.dev.env

@@ -0,0 +1,22 @@
+# Node ENV for DEVELOPMENT
+# Update PRIVATE section below with correct value 
+# Rename this file to ".dev.env"
+# 
+#
+
+
+# Public section:-
+MONGODB_URI='mongodb://127.0.0.1:27017/curiosity'
+
+
+# PRIVATE section:-
+
+# Before using passport-github, you must register an application with GitHub. 
+# If you have not already done so, a new application can be created at developer applications within GitHub's settings panel.
+# https://github.com/settings/applications/new
+# 'Homepage URL' -> 'http://localhost:3000'
+# 'Authorization callback URL' ->  'http://localhost:3000/auth/github/callback'
+# Your application will be issued a client ID and client secret. please update following with correct value.
+
+GITHUB_CLIENT_ID='--insert-github-client-id-here--'
+GITHUB_CLIENT_SECRET='--insert-github-client-secret-here--'