Skip to content

Commit 07113ba

Browse files
committed
added images for README
1 parent 9ea264d commit 07113ba

File tree

3 files changed

+32
-8
lines changed

3 files changed

+32
-8
lines changed

README.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Node Skeleton
22

3-
## Project Setup
3+
##Consensus
4+
Making decisions is hard. Why not step back and let someone else do it? Consensus lets you create polls on any subject, and send links to whoever you want. Friends anonymously rank their choices, and you get to see the aggregate results. Easy as pie!
45

5-
1. Create your own empty repo on GitHub
6-
2. Clone this repository (do not fork)
7-
- Suggestion: When cloning, specify a different folder name that is relevant to your project
8-
3. Remove the git remote: `git remote rm origin`
9-
4. Add a remote for your origin: `git remote add origin <your github repo URL>`
10-
5. Push to the new origin: `git push -u origin master`
11-
6. Verify that the skeleton code now shows up in your repo on GitHub
6+
## File Setup
7+
1. This app uses Nodemailer to send emails via Gmail. You will need to create a `secrets.js` file with the following setup:
8+
9+
`const emailPassword = "<YOUR EMAIL PASSWORD>";
10+
const userEmail = "<THE GMAIL ADDRESS YOU WILL SEND FROM>";
11+
module.exports = {
12+
emailPassword,
13+
userEmail
14+
}`
1215

1316
## Getting Started
1417

@@ -23,7 +26,28 @@
2326
7. Run the server: `npm run local`
2427
8. Visit `http://localhost:8080/`
2528

29+
##Using Consensus
30+
31+
Register and log in to use the app. Your polls will be displayed on the "My Polls" page.
32+
33+
34+
35+
Each poll is a link to an admin page where you can get details such as the number of responses and the curret results.
36+
2637
## Dependencies
2738

2839
- Node 5.10.x or above
2940
- NPM 3.8.x or above
41+
- bcrypt 2.0.0
42+
- body-parser 1.15.2 or above
43+
- cookie-session 1.3.2 or above
44+
- dotenv 2.0.0 or above
45+
- ejs 2.4.1 or above
46+
- express 4.13.4 or above
47+
- knex 0.11.7 or above
48+
- knex-logger 0.1.0 or above
49+
- mailgun-js 0.19.0 or above
50+
- morgan1.7.0 or above
51+
- node-sass-middleware 0.9.8 or above
52+
- nodemailer 4.6.7 or above
53+
- pg 6.0.2 or above
Loading
Loading

0 commit comments

Comments
 (0)