-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
74ae3b8
commit a1ea8d5
Showing
1 changed file
with
20 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,11 @@ | ||
# Girls Write Now | ||
This project is designed and developed by a team of UC Berkeley students through one of [Cal Blueprint](https://calblueprint.org/)'s project teams during the 2022-23 academic year. | ||
|
||
This project is designed and developed by a team of UC Berkeley students through one of [Cal Blueprint](https://calblueprint.org/)'s project teams during the 2022-23 academic year. | ||
|
||
Learn more about [Vouchers 4 Veggies](https://girlswritenow.org/) and [Cal Blueprint](https://calblueprint.org/). | ||
|
||
--- | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
@@ -21,18 +23,18 @@ We strongly recommend using a Node version manager like [nvm](https://github.com | |
|
||
1. Clone the repo & install dependencies | ||
1. Clone this repo | ||
* using SSH (recommended) | ||
```sh | ||
git clone [email protected]:calblueprint/girls-write-now.git | ||
``` | ||
* using HTTPS | ||
```sh | ||
git clone https://github.com/calblueprint/girls-write-now.git | ||
``` | ||
2. Enter the cloned directory | ||
- using SSH (recommended) | ||
```sh | ||
git clone [email protected]:calblueprint/girls-write-now.git | ||
``` | ||
- using HTTPS | ||
```sh | ||
cd girls-write-now | ||
git clone https://github.com/calblueprint/girls-write-now.git | ||
``` | ||
2. Enter the cloned directory | ||
```sh | ||
cd girls-write-now | ||
``` | ||
3. Install project dependencies. This command installs all packages from [`package.json`](package.json). | ||
```sh | ||
npm install | ||
|
@@ -42,8 +44,10 @@ We strongly recommend using a Node version manager like [nvm](https://github.com | |
2. Copy the credentials from [Blueprint's internal Notion](https://www.notion.so/calblueprint/Secrets-34fde2e9c9bb41d0ad1cb2bebedadd28?pvs=4) (access is required) and paste them into the `.env` file. | ||
|
||
**Helpful resources** | ||
* [GitHub: Cloning a Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository#cloning-a-repository) | ||
* [GitHub: Generating SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) | ||
|
||
- [GitHub: Cloning a Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository#cloning-a-repository) | ||
- [GitHub: Generating SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) | ||
|
||
### Development environment | ||
|
||
- **[VSCode](https://code.visualstudio.com/) (recommended)** | ||
|
@@ -57,6 +61,6 @@ We strongly recommend using a Node version manager like [nvm](https://github.com | |
npx expo start | ||
``` | ||
2. There are several ways to test the app: | ||
- **Expo Go (Recommended)**: [download Expo Go](https://docs.expo.dev/get-started/installation/#2-expo-go-app-for-android-and) on your phone, **connect to same network as your laptop**, and use your phone camera to scan the QR code displayed in the command line. | ||
- Web: typing `w` into the expo command line opens the app in a web view. | ||
- Warning: since the app is designed to be used on a mobile app, web compatibility might be limited, and some functionality might be different when using the web setup. | ||
- **Expo Go (Recommended)**: [download Expo Go](https://docs.expo.dev/get-started/installation/#2-expo-go-app-for-android-and) on your phone, **connect to same network as your laptop**, and use your phone camera to scan the QR code displayed in the command line. | ||
- Web: typing `w` into the expo command line opens the app in a web view. | ||
- Warning: since the app is designed to be used on a mobile app, web compatibility might be limited, and some functionality might be different when using the web setup. |