Skip to content

Commit f72091a

Browse files
katrinajaneczkokatrinajaneczko
authored
Merge pull request #80 from Capstone-Projects-2023-Spring/qa-readme-update
Qa readme update
2 parents 55fc4a3 + 5eaf052 commit f72091a

6 files changed

Lines changed: 102 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,19 @@
1313
## Directions
1414

1515
* Please navigate to our app by clicking [this link](http://68.183.30.203:3000/). Once there, you can create an account, select a pet, and explore the site.
16+
* Study Buddy is a Progressive Web App (PWA). This means it's a web site that you can use in your browser, or it can be downloaded to your device and used like an app.
17+
* On iOS: Open Safari and navigate to the site. Press the "Share" button and select "Add to Home Screen" from the popup. Lastly, tap "Add" in the top right corner to finish installing the PWA. It will now be on your home screen.
18+
* On Android: Open Chrome and navigate to the site. Press the "three dot" icon in the upper right to open the menu. Select "Add to Home screen." Press the "Add" button in the popup. The PWA is now installed and available on your home screen.
19+
![Study buddy pwa instructions!](https://user-images.githubusercontent.com/73796086/227796829-3a226862-e33f-45ff-bac6-83efcccd883a.png)
1620
* The following pages are functional: Register, Login, Home, Account, Canvas Integration, and Logout.
1721
* On the Home page, you'll see your chosen pet and its name. You can modify the pet's name and bio by clicking on the Profile tab.
1822
* You can add tasks in the Tasks tab. When you check a task off, it is marked completed and you earn a candy.
1923
* To view your inventory of candies earned from completing tasks, go to the Inventory tab. You can feed your pet by dragging and dropping candies onto it, and watch the progress bar fill up.
2024
* The Calendar and Progress tabs are currently under development.
2125
* On the Canvas Integration page, you can follow directions to generate and upload a Canvas API token to import your assignments from Canvas into the application.
2226
* If you encounter any bugs or issues, please visit our <a href="https://capstone-projects-2023-spring.github.io/project-virtual-pet/">documentation site</a> and click on the "Report Bug" button located on the right-hand side of the page. This will take you to a feedback form where you can provide details about the problem you encountered.
27+
* Points of contact: Mary Clay (mary.clay@temple.edu) & Alexander Russakoff (alexander.russakoff@temple.edu)
28+
* For QA testing purposes, please reference the [Acceptance Testing document](https://docs.google.com/spreadsheets/d/1cuUb6Kp730-dWrmaLGF4BwymjM5wOjrheQmZXhBRBhs/edit?usp=sharing).
2329

2430
## Keywords
2531

@@ -58,6 +64,70 @@ Another closed-source mobile application, titled [Finch](https://finchcare.com/)
5864

5965
Research will need to be conducted on the various software resources needed to complete this project, including JavaScript, React, HTML/CSS, Django, SQLite, and Canvas API. React will be used for the front-end, Django for the back-end, and a combination of a SQLite Database with a schema defined and managed by Django and a Static File store. A required resource is an Ubuntu server which will either be run on an old laptop or a hosting service will be used. No other hardware resources are required.
6066

67+
## Local Build Instructions
68+
69+
### Prerequisites
70+
71+
* Python 3.8 or higher
72+
73+
* pip3 22 or higher
74+
75+
* npm 8 or higher
76+
77+
> A secret key and a gmail password will be required in backend `.env` file for the project to run correctly. If you are an approved developer on this project, reach out to your team lead to receive the requisite credentials. Modification of the backend code source code will be required in order to send email verifications on user registration. Our team is happy to assist in guiding you through this process.
78+
79+
### Set Up
80+
81+
1. <a href=https://github.com/Capstone-Projects-2023-Spring/project-virtual-pet/releases>Download</a> the zip file in the release and open. Open a terminal, then navigate to the project directory.
82+
83+
2. Insert your development keys to `~/sb/backend/.env`
84+
```
85+
SECRET_KEY=<YOUR-KEY>
86+
GMAIL_PASSWORD=<YOUR-PASSWORD>
87+
```
88+
3. Navigate to the backend:
89+
90+
```bash
91+
cd <your-path>/sb/backend
92+
```
93+
94+
4. Activate a Python virtual environment and install dependencies:
95+
> (MacOS/Unix)
96+
97+
```bash
98+
source tutorial-env/bin/activate
99+
pip3 install -r requirements.txt
100+
```
101+
> Windows
102+
103+
```bash
104+
tutorial-env\Scripts\activate.bat
105+
pip3 install -r requirements.txt
106+
```
107+
108+
5. Activate the backend with the following instructions:
109+
110+
```bash
111+
python3 manage.py makemigrations
112+
python3 manage.py migrate
113+
python3 manage.py runserver
114+
```
115+
116+
6. Now, open a new terminal and from the project directory, navigate to the frontend:
117+
118+
```bash
119+
cd <your-path>/sb/frontend
120+
```
121+
7. Build the frontend as follows. Dependencies will be downloaded and compiled for you:
122+
123+
```bash
124+
npm install
125+
npm run build
126+
nmp start
127+
```
128+
8. In your browser, navigate in the search bar to <a href="http://localhost:3000">http://localhost:3000</a>.
129+
130+
61131
## Collaborators
62132

63133
[//]: # ( readme: collaborators -start )

‎documentation/docs/api-specification/backend-class-doc.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 6
2+
sidebar_position: 2
33
description: Backend class descriptions.
44
---
55

‎documentation/docs/api-specification/backend-sphinx.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
# Study Buddies Backend Sphinx Docs
1+
---
2+
sidebar_position: 3
3+
description: Documentation for backend generated by Sphinx framework.
4+
---
5+
6+
Backend Sphinx Docs
7+
=============================
28

39
<a target="_blank" href={"/sphinx/index.html"} >
410

511
Click Here For Docs!!!
612

7-
</a>
13+
</a>

‎documentation/docs/api-specification/canvas-endpoints.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 5
2+
sidebar_position: 6
33
description: Canvas endpoints necessary to retrieve the information we need from a user's Canvas account.
44
---
55

‎documentation/docs/api-specification/openapi-spec.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
---
2-
title: Study Buddies - User Registration and Validation API
3-
description: User Registration and JWT Token exchange endpoints
2+
sidebar_position: 4
43
hide_table_of_contents: true
5-
sidebar_position: 2
4+
description: User Registration and JWT Token exchange endpoints
65
---
76

7+
User Registration and Validation API
8+
=============================
9+
10+
## Component Hierarchy / Directory
11+
812
import ApiDocMdx from '@theme/ApiDocMdx';
913

1014
<ApiDocMdx id="using-single-yaml" />

‎documentation/docs/api-specification/swagger-api.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
sidebar_position: 5
3+
description: Interactive API documentation for our RESTful API
4+
---
5+
6+
OpenAPI (Swagger) Specification
7+
=============================
8+
9+
[![Link](https://img.shields.io/badge/-Click%20Here%20to%20Open-orange)](http://68.183.30.203:8000/api/schema/swagger-ui/)
10+
11+
### Interactive documentation / API description format for our RESTful APIs describing our entire API, including:
12+
* available endpoints and operations on each endpoint
13+
* operation parameters
14+
* input and output for each operation
15+
* authentication methods

0 commit comments

Comments
 (0)