Skip to content

Commit

Permalink
Beginning Contributor List and Moving/Modifiying PR Template (#171)
Browse files Browse the repository at this point in the history
* README contributors section

* moving pull request template and slight modification

* adding linear ticket link to pr template
  • Loading branch information
merrickliu888 authored Nov 3, 2024
1 parent b128960 commit fb52b40
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 16 deletions.
7 changes: 3 additions & 4 deletions pull_request_template.md → .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Description
## Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
[Linear Ticket]() <!-- Put URL of Linear Ticket in parentheses -->

Fixes # (issue/ticket number)
<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change: -->

## Type of change

Expand All @@ -15,7 +15,6 @@ Please delete options that are not relevant.

# Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation (if required)
Expand Down
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The Period Purse strives to achieve menstrual equity by providing people who men
The [wiki](https://github.com/uoftblueprint/the-period-purse/wiki) has a lot of relevant information related to branching, PRs, etc that you should review!

# Table of Contents

- [The Period Purse](#the-period-purse)
- [For Developers](#for-developers)
- [Table of Contents](#table-of-contents)
Expand All @@ -21,36 +22,49 @@ The [wiki](https://github.com/uoftblueprint/the-period-purse/wiki) has a lot of
- [Common Setup Errors](#common-setup-errors)

<a name="setup-mac"></a>

# Setup Local Environment (Mac)

Prerequisites:

Ensure you have the following prerequisites before trying to run the project locally:
- Node.js and npm (https://nodejs.org/en/download/). Alternatively, check if you have this by using command ```node -v```
- Once you have Node.js and npm, run command ```npm install -g expo-cli```
- You will need an iOS simulator. If you have a Macbook, its recommended you install XCode from the app store as it has a built in iOS simulator. If you have a Windows machine, unfortunately you will have to install a virtual machine to run the iOS simulator.

1. Clone this repository using ```git clone https://github.com/uoftblueprint/the-period-purse.git```
2. cd into folder tpp-app ```cd ./tpp-app```
3. run ```npm install```
4. cd into folder ios ```cd ./ios```
5. Install pods ```pod install```
6. cd back out to tpp-app folder ```cd ..```
7. Run the project using ```npm run ios```
Ensure you have the following prerequisites before trying to run the project locally:

- Node.js and npm (https://nodejs.org/en/download/). Alternatively, check if you have this by using command `node -v`
- Once you have Node.js and npm, run command `npm install -g expo-cli`
- You will need an iOS simulator. If you have a Macbook, its recommended you install XCode from the app store as it has a built in iOS simulator. If you have a Windows machine, unfortunately you will have to install a virtual machine to run the iOS simulator.

1. Clone this repository using `git clone https://github.com/uoftblueprint/the-period-purse.git`
2. cd into folder tpp-app `cd ./tpp-app`
3. run `npm install`
4. cd into folder ios `cd ./ios`
5. Install pods `pod install`
6. cd back out to tpp-app folder `cd ..`
7. Run the project using `npm run ios`
8. Install debugger with this [tutorial](https://github.com/uoftblueprint/the-period-purse/wiki/Installing-Debugger)
9. The simulator should open automatically and you should see something like the following image, with the Menstruation Nation app on the home screen:

<img width="378" alt="Screen Shot 2021-10-27 at 11 46 38 AM" src="https://user-images.githubusercontent.com/35851484/139100763-95605bfc-a224-401b-9f17-b3a5e0a3f3fb.png">

<a name="setup-windows-linux"></a>

# Setup Local Environment (Windows/Linux)

## Windows

Menstruation Nation does not support development on Windows. You may choose to create a virtual machine with a tutorial like this: [video](https://www.youtube.com/watch?v=Q55e2Tz-818).

## Linux

Follow this [tutorial](https://www.youtube.com/watch?v=c30RLycIpVY).

<a name="errors"></a>

# Common Setup Errors

Please check out the [wiki](https://github.com/uoftblueprint/the-period-purse/wiki/Common-Setup-Errors).

## Contributors

This project would not be possible without the combined efforts of the TPP Blueprint team (2024-2025):

[Merrick Liu](https://github.com/merrickliu888), [Paridhi Goel](https://github.com/paridhi26), [Patricia Santos](https://github.com/santoaast)

0 comments on commit fb52b40

Please sign in to comment.