Consultancy - Evaluation
Presentation and Documentation
Choose either Live Demo or Video Presentation to Complete:
-
Team members who are not part of the demo/presentation, participate in Q&A
- Live Demo
- End-to-end demo on localhost
- End-to-end demo in production
- Video Presentation
- Team has prepared a demonstration video
- Video displays end-to-end application demo of happy path
- Video discusses persona analysis and user empathy
- Video discusses service-oriented architecture
Slide Presentation
- Outlines MVP of the project
- Discusses end users, persona analysis
- Discusses technical design choices made
README and Documentation
Each Repo’s README meets the following:
- links to other project repos & production links
- contains a list of contributors, their GitHub profiles and LinkedIn profiles
- discusses the purpose of its purpose (how it fits into the project SOA)
- discusses how to install and test the repo
Rails front-end README:
- has screenshots
- discusses OAuth
Rails back-end README:
- includes database schema
- each endpoint is documented with example request & response
Microservice READMEs:
- each endpoint exposed to the back-end
- its use of external service API
When the above criteria is met, here are additional points to achieve a 4
Demo or Presentation
- ENV variables are changed on Heroku to point to invalid backend/services or API keys, or backend services are somehow taken offline; front-end shows a user-friendly error scenario
Documentation
- A Postman collection JSON file is included in the following repos(except for any portion which needs OAuth)
- Rails Back End
- Microservice 1
- Explains user personas and exhibits user empathy
- Rails Front End