@tutorbook/navigation v0.6.5

A PWA (Progressive Web App) designed to optimize the process required to get a student with a qualified tutor.

After discovering just how un-streamlined the existing process was at the Gunn Academic Center, I decided it could be much more efficient through the use of technology (previously, one would have to manually fill out and turn in a request form to the office and then wait for the AC Staff to match the student with the tutor). Now, Gunn and Paly students can request and message peer tutors from anywhere at anytime, track service hours using a phone or a school-issued laptop, hire professional at-home tutors when necessary, and connect with middle school students all from within our web app.

Read more about me and view the open source code here.

Contributing

We need help. To contribute to Tutorbook, either go through our issues or our Notion task page to find something that you'd be interested in working on. Then, checkout from develop and create a PR for whatever task you've been contributing to.

File Structure

Our app primarily consists of 28 (and counting) subpackages (included in src/app/packages) managed by lerna that are webpacked into three files for distribution (included in build/app):

.
├── build
│   ├── app
│   │   ├── index.html
│   │   ├── scripts
│   │   │   └── bundle.min.js
│   │   └── styles
│   │       └── bundle.min.css
│   ├── index.html
│   └── site
└── src
    ├── app
    │   ├── lerna.json
    │   ├── package-lock.json
    │   └── packages
    │       ├── app
    │       │   ├── index.js
    │       │   ├── package.json
    │       │   └── styles
    │       │       ├── cards.scss
    │       │       ├── chat.scss
    │       │       ├── profile.scss
    │       │       ├── search.css
    │       │       ├── user.css
    │       │       └── welcome.scss
    │       ├── dialogs
    │       │   ├── index.js
    │       │   └── package.json
    │       ├── render
    │       │   ├── index.js
    │       │   └── package.json
    │       └── templates
    │           ├── index.js
    │           ├── package.json
    │           └── templates.html
    └── site

Developing

To set up a development environment for and to contribute to the Tutorbook web app:

1. Follow these instructions to install nvm (our suggested way to use Node.js) on your machine. Verify that nvm is installed by running:

$ command -v nvm

2. Run the following command to install Node.js v10.10.0 (our current version):

$ nvm i 10.10

3. Ensure that you have recent versions of Node.js and it's package manager npm by running:

$ node -v
10.10.0
$ npm -v
6.13.3

4. Clone and cd into this repository locally by running:

$ git clone https://github.com/tutorbookapp/tutorbook.git && cd tutorbook/

5. Then, you'll most likely want to branch off of develop and cd into our app packages by running:

$ git checkout -b $my_branch && cd src/app/packages

6. From there, cd into your desired package, make your changes, commit them to your branch off of develop, and open a PR on GitHub.