swoloszynski / journey-planner

Trugley, your favorite travel app for telling people where you're gonna be, who you're gonna be with, and how you're gonna get there.

journey-planner

Trugley, your favorite travel app for telling people where you're gonna be, who you're gonna be with, and how you're gonna get there.

Set up

Follow instructions in Install doc.

(journey-planner) $ nvm use
(journey-planner) $ yarn
(journey-planner) $ npm start

Running tests

(journey-planner) $ npm test

Project Structure

Name	Description
.env	Your API keys, tokens, passwords and database URI.
.eslintrc	Rules for eslint linter.
.gitignore	Folder and files ignored by git.
.travis.yml	Configuration files for continue integration.
app.js	The main application file.
package.json	NPM dependencies.
package-lock.json	Contains exact versions of NPM dependencies in package.json.

journey-planner's Issues

Show if user is logged in on home page

• If logged in, show user name / link to profile page
• If not logged in, show log in / sign up links

Add validation to email and password fields

• So you can't signup with a non-email email address or a blank password, for example

Unit test flash displaying flash error messages on form pages

Set up unit tests for api controllers

• Eg test that hitting a route calls the correct controller function

Add contact data model

• Schema doc
• ER diagramo

Add third party login

• Probably OAuth or social

Add time period data model

• Schema doc
• ER diagramo

Add example api routes

What

• Add skeleton for API files
• Add create and get routes for users model

References

• https://scotch.io/tutorials/getting-started-with-node-express-and-postgres-using-sequelize#creating-controllers-and-routing

Set up unit tests for models

• Set up test database created at runtime
• Eg tests that creation fails if a field is missing
• Using frameworks mocha and chai
• Start familiarizing yourself with the testing concepts of "mocking" and "stubbing" and "spies"

Choose language and framework

• Write out pros and cons for each
• RoR, Django, Node
• Choose one
• Add 'why' notes to project readme

Add logout

• Add a POST endpoint that executes passport's logout function
• Once logged out, redirect to homepage
• If logged in, show logout link on profile page

update install doc

to include nvm use

Separate controllers for api and app

Add initial data models

• Db schema migration
• Based on ER diagram
• Be able to manually add records

Add templating

Eg pug

Add transit data model

• Schema doc
• ER diagramo

Only allow auth'ed users to see profile page

• If not logged in, redirect to login page
• If logged in, display user info on profile page

Turn repo to private under Ben's account

Set up continuous integration

• For running test suite on PR and merges

Error starting server `npm start` + solution

Received the following error after running npm start:

SyntaxError: /Users/bentravis/Projects/journey-planner/config/config.json: Unexpected token 
 in JSON at position 0

Solution:
Ran old config.json file through https://jsonlint.com/ and came up with:

https://gist.github.com/btrav/a6292bd4a163a9c48ec6cc4b85d8d907

Add fields to signup form

• Add field for all non-nullable fields (or remove the field) instead of using email as placeholder

Add local login

https://scotch.io/tutorials/easy-node-authentication-setup-and-local

Create front end layout skeleton in templates

Eg add materialize

Create persistent log in session

• serialize and deserialize user in passport configs
• store auth token?
• middleware for checking if auth'ed

Set up github project planning

Add linter

Add jslint and configure to run with tests

Configure JPEGs to Clickable Prototype

Upload images and create relevant associations for clicks/actions.

Set up testing framework

• Simple get test as first test
• mocha, supertest
• sinon (possibly defer)

Set up unit tests for app controllers

• Test that hitting a route results in certain content returned on the page

Dev set up and initialize new project

• Eg install LTS versions of language, framework, etc
• Initialize the project
• Instructions for setting up dev environment

Create first round of dev tickets

To get to the skeleton app

Display if logged in on home page

• If not logged in, display text "not logged in"
• Check for logged in cookie?
• Ping logged in API endpoint
• If logged in, display text "Logged in as [username]"

Add HTML best practices to templates

• Meta tags, etc
• https://html5boilerplate.com/
• https://pugjs.org/api/getting-started.html

Add trip data model

• Schema doc
• ER diagramo

Finish user flow and create rest of wireframes in Whimsical

User Flows: https://whimsical.co/JQos9GGZP7z82yo4uk14uG
Wireframes: https://whimsical.co/V5XEYrKFxCpvVTiLGwxVwr

Unit test config/password

Deploy skeleton app to staging

• Netlify, Heroku, AWS, etc
• Set up DB
• Add deploy instructions

Automatically log user in after signing up

Move wireframes from Whimsical to JPEGs

In preparation for clickable prototype

Set up database locally

• Decide which database to use (likely MySQL)
• Local set up - initialize and first migration
• Document initialization instructions

Auto restart server on changes

• eg nodemon

Architect and ticket password reset

• forgot password route / form
• add reset token field and reset expiration field to db schema
• forgot password POST endpoint -> create and save new reset token for user
• send reset email with link
• reset route/form that takes the reset token as a param and shows form for new password OR invalid token page
• reset POST endpoint -> receive new password, hash and save it to the database, and expire the reset token
• redirect to login or login automatically

Add account models linked to third party login records

• Start simple, eg username
• db schema migration
• Confirm instructions for db migrations are up to date
• Migrate locally and on staging

Create initial wireframes based on paper prototype

Create wireframes based on paper prototypes

Add API endpoint for checking if logged in

Redirect to prior page after being redirected to login

• Eg if you were redirected to login from /profile, after logging in, send the user back to the page they were trying to access (params?)

Set up configs

Make config directory with configs for each environment. No hardcoded sensitive info, use env vars. Eg https://www.codementor.io/olatundegaruba/integration-testing-supertest-mocha-chai-6zbh6sefz