Expo: On phone runtime of app GenyMotion: Android emulator
- Homepage
- Login & users db
- News
- Events
- Store & "microtransactions"
- 3 starter pets
- Selecting desired charities
- Rules page
- Roaming pets
- Minigame (shower, dogwalking, training tricks?)
- Donation contribution progress bar ("Your contributions allowed 10 puppies to be fed this week!")
- Pet needs
- More pets!
- Aesthetic food + water
- Naming pets
- Treats in News & Events pages to be collected
- Achievements page
- Checkin rewards (new pets, new toys, treats upgrades)
- Filter news and events from charities by user interest
- RSVP for events
- User settings page (chosen charities and percentages, chosen news and events filter level, etc)
| MVP | DB Tables | APIs | Reducers | Actions |
|---|---|---|---|---|
| Login, register & users db | Users table | Refer to auth exercise | Refer to exercise | Refer to exercise |
| Selecting desired charities | Charities, CharitiesAndUsers table | GET, POST /users/:id/charities | ActiveCharities | |
| Homepage | Animals, AnimalsAndUsers tables | GET, POST /users/:id/animals. GET, POST /users/:id/cosmetics. GET, POST /animals/:id/cosmetics/ | UserPets, Amenities, Clock, ActivePet | UPDATE_ACTIVE_PETS, FILL_WATER, FILL_FOOD, REDUCE_WATER, REDUCE_FOOD, UPDATE_ENTER_TIME, UPDATE_EXIT_TIME |
| News | News table | GET /events | EventsCarousel, ActiveNews | UPDATE_ACTIVE_NEWS |
| Events | Events table | GET /events | EventsCarousel, ActiveEvent | UPDATE_ACTIVE_EVENTS |
| Store & "microtransactions" | Cosmetics, CosmeticsAndUsers, CosmeticsAndAnimals | GET /store/inventory. GET, POST /users/:id/cosmetics. GET, POST /animals/:id/cosmetics/ | StoreCarousel, ActiveStoreCarousel, ActiveItem | |
| Rules page | ||||
| 3 starter pets | Animals, AnimalsAndUsers tables |
/*** | MVP | DB Tables | APIs | Reducers | | --- | --- | --- | --- | --- | | Login, register & users db | Users table | Refer to auth exercise | Refer to exercise | Refer to exercise | | Selecting desired charities | Charities, CharitiesAndUsers table | GET, POST /users/:id/charities | ActiveCharities | | Homepage | Animals, AnimalsAndUsers tables | GET, POST /users/:id/animals. GET, POST /users/:id/cosmetics. GET, POST /animals/:id/cosmetics/ | UserPets, Amenities, Clock, ActivePet | | News | News table | GET /news | NewsCarousel, ActiveNews | | Events | Events table | GET /events | EventsCarousel, ActiveEvent | | Store & "microtransactions" | Cosmetics, CosmeticsAndUsers, CosmeticsAndAnimals | GET /store/inventory. GET, POST /users/:id/cosmetics. GET, POST /animals/:id/cosmetics/ | StoreCarousel, ActiveStoreCarousel, ActiveItem | | Rules page | | | | | 3 starter pets | Animals, AnimalsAndUsers tables | | | ***/
| Stretch | DB Tables | APIs | Reducers | Actions |
|---|---|---|---|---|
| Roaming pets | ||||
| Minigame | ||||
| Donation contribution progress bar | ||||
| Pet needs | ||||
| More pets! | ||||
| Aesthetic food + water | ||||
| Naming pets | ||||
| Treats in News & Events pages | ||||
| Achievements page | ||||
| Checkin rewards |
| Table Name | Columns |
|---|---|
| Users | id, username, password, email, coins |
| Animals | id, name, species, disposition |
| AnimalsAndUsers | animalId, userId |
| Charities | id, charityName, mission, websiteURL, logo |
| CharitiesAndUsers | userId, charityId, donationPercent |
| News | id, organisation, headline, content, photo |
| Events | id, organisation, headline, content, photo, location, dateAndTime |
| Cosmetics | id, name, image, price |
| CosmeticsAndUsers | userId, cosmeticId |
| CosmeticsAndAnimals | animalId, cosmeticId |
| Section | Reducer | Use | Format | Actions |
|---|---|---|---|---|
| Homepage | UserPets | Showing current pets | an array of all pets the current user owns. | |
| Homepage | Amenities | Food and drink info for friends | Object containing water and food levels | FILL_WATER, FILL_FOOD, REDUCE_WATER, REDUCE_FOOD |
| Homepage | Clock | Stores info about time including time since last login | Object containing current time and last login time | UPDATE_ENTER_TIME, UPDATE EXIT_TIME |
| Homepage | ActivePet | Stores info about the current user's pets | an array of all pets the current user owns. | UPDATE_ACTIVE_PETS |
| News | NewsCarousel | Stores all news stories to be shown | An array of objects representing all news stories | |
| News | ActiveNews | Contains either the current news story, or nothing, to be used as a switch | A single News object, or null | UPDATE_ACTIVE_NEWS |
| Events | EventsCarousel | Stores all events to be shown | An array of objects representing all events | |
| Events | ActiveEvent | Contains either the current event, or nothing, to be used as a switch | A single Event object, or null | UPDATE_ACTIVE_EVENT |
| Store | StoreCarousel | Stores entire purchase catalogue | Object of keys "Cosmetics", "Pets", etc, with entire store catalogue contained | BUY_ITEM |
| Store | ActiveStoreCarousel | Used to switch between what catalogue subset is displayed | String of "Cosmetics", "Pets", etc | UPDATE_ACTIVE_STORE_CAROUSEL |
| Store | ActiveItem | Displays the selected store item if not null, containing purchase info, details, description | Either active item object, or null | UPDATE_ACTIVE_ITEM |
| Register/Login | ActiveCharities | UPDATE_ACTIVE_CHARITES |
| Method | Endpoint | Protected | Usage | Response |
|---|---|---|---|---|
| GET | /charities/all | --- | Gets all charities available | An array of charity objects |
| GET | /users/:id/charities | --- | Gets the current user's charity choices | An array of charity objects |
| POST | /users/:id/charities | --- | Sets the current user's charity choices | An array of charity objects |
| GET | /users/:id/animals | --- | Returns all animals adopted by that user | An array of animal objects |
| POST | /users/:id/animals | --- | Updates animals adopted by that user | The new animal object |
| GET | /users/:id/inventory | --- | Returns the current user's inventory | An inventory object with keys/value pairs where each value is an array |
| POST | /users/:id/inventory | --- | Updates the current user's inventory | The updated inventory object |
| GET | /animals/:id/inventory/ | --- | Returns the current animal's inventory | An inventory object with keys/value pairs where each value is an array |
| POST | /animals/:id/inventory/ | --- | Updates the current animal's inventory | The updated inventory object |
| GET | /news | --- | Gets all news items | Returns an array of news objects |
| GET | /events | --- | Gets all events | Returns an array of events objects |
| GET | /store/inventory | --- | Gets entire store catalogue | Returns an object containing entire store inventory |
Method Endpoint Protected Usage Response Post /api/auth/login Yes Log In a User The Users JWT Token Post /api/auth/register Yes Register a User The Users JWT Token Get /api/meetings Yes Get a Users Meeting Histroy An Array of Meetings
{ Cosmetics: [ "hat", "jacket" ],
}
[
{
id: 1,
charityName: "Puppies Motel",
mission: "Just get it done",
websiteURL: "www.totes-puppies.com",
logo: "puppies-motel.jpg",
donationPercent: 40
}
]
[
{
charityId: 1,
donationPercent: 40
}
]
[
{
id: 1,
charityName: "Puppies Motel",
mission: "Just get it done",
websiteURL: "www.totes-puppies.com",
logo: "puppies-motel.jpg",
donationPercent: 40
}
]
[
{
id: 1,
name: "Chippy",
species: "Dog",
disposition: "Sassy"
}
]
[
{
userId: 1
animalId: 1,
name: "Chippy",
species: "Dog",
disposition: "Sassy"
}
]
[
{
id: 1,
name: "Chippy",
species: "Dog",
disposition: "Sassy"
}
]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent