Build Badges
Any Badges you have that should be here, e.g. Codeship, TravicCI, whatever.
Product Owner: Joe Example - joe@example.com
- Kickoff Date:
- Project Duration:
- Current end of contract Date:
| Thing | Location |
|---|---|
| Waffle Board/Kanban Board | link |
| Google Drive | link |
| Sprint Reports | link |
| Continuous Integration | link |
| Staging | link |
| Production | link |
| iOS App Store | link |
| Google Play Store | link |
| OS | Browsers |
|---|---|
| Windows | IE 11+, Chrome (latest), Firefox (latest), Edge (latest) |
| Mac | Chrome (latest), Firefox (latest), Safari (latest) |
| iOS | Safari (latest) |
| Android | Chrome (latest) |
| Platform | OS Version | Install Base |
|---|---|---|
| iOS | 10 and above | https://developer.apple.com/support/app-store/ |
| Android | 4.4 (KitKat) and above | https://developer.android.com/about/dashboards/index.html |
| Platform | Devices |
|---|---|
| iOS | iPhone 6 and newer |
| Android | Samsung S6, S7, and S8 families |
What is your project? What's the general overview on it?
Brief introduction to product owner or company or whover this thing is for
What's the pain point? Why does this thing need to be built?
What should this thing do in a nutshell. No bells or whistles, this is what the app does on the most basic level
The who and what of the project. What user types live in this project? Admins, Customers etc. Maybe there's a piece of a user profile that could provide some context. Add it Here.
The actions users take within the application. Maybe you buy something or connect with a friend. List those actuons here.
| Role | Person | |
|---|---|---|
| Client | Joe Example | joe@example.com |
| Product Owner | Joe Example | joe@example.com |
| Product Manager | Jimmy PM | jimmy@example.com |
| Tech Lead | Bobby SmartGuy | bobbysg@example.com |
| Engineer | Phil KindaSmartGuy | phil@example.com |
| Designer | Pretty FontsAndShapes | nicegrids@example.com |
| QA | Testy McTesterson | senditback@example.com |
| Business Analyst | Numbers McGhee | 2+2@example.com |
| Account Manager | Fall Guy | imsorry@example.com |
Just a header but everything following is "How do I get this thing running locally?"
What's the stack Ruby on Rails? Elixr? JS Front End with Mongo DB? List it all here
Step by step process of getting this thing running. Hopefully you have an install script. If not then get super detailed right here
Prerequisites (as of 11/7):
- Ruby 2.1.10
- Elasticsearch 1.7 -- (instructions)[https://www.elastic.co/guide/en/elasticsearch/reference/1.7/_installation.html]
$ ./bin/setup
Create a .env file and add the contents of .env.example. Get any missing values from Heroku or another dev. Open a new terminal to load the new env vars.
$ ./bin/start
http://localhost:3000 will take you to the Mainsite (Maritant).
http://lvh.me:3000 will take you to the Scurlock minisite.
bundle exec rspec
If all your tests are failing with PG::UndefinedTable errors, run bundle exec rake db test:prepare and try again.
- disable rack_attack in config
- install
locust.ioload testing software. - run the locustfile in the devops directory