Hey Mentor app

Contributing

There are many ways to participate in the project. Just to name a few:

• Submit bugs and feature requests
• Review code changes
• Review documentation and make pull requests for updates

If interested in contirbuting directly to the code, please review the following:

• How to build and run from source:
  1. Make sure you have a GitHub account. If not, create one.
  2. Install Node.js LTS.
  3. Install Visual Studio Code or other editor.
  4. git clone https://github.com/Hey-Mentor/web hm
  5. cd hm
  6. npm install
  7. gatsby develop
  8. Open local site at http://localhost:8000
• Development workflow, including debugging and running tests
  • Roadmap – Basic roadmap with high-level themes and features per release.
  • Iterations – We work in monthly iterations with small, modest goals.
  • Planning – We try to identify what work can be completed before each iteration starts. Each iteration seeks to bring us closer to the next milestone in the roadmap.
  • Quality – We strive to attain high quality in everything we do, including consideration for:
    • Accessibility
    • Localization
    • Dark and high contrast mode
• Coding guidelines
• Submitting pull requests
• Finding an issue to work on
• Contributing to translations

Feedback

• Request a new feature
• Upvote existing feature requests
• File an issue
• Follow Hey Mentor on Twitter or Instagram

Architecture

Hey Mentor Web uses React, Gatsby, and Fluent UI. Here are a few tips for working with each...

React

Learn more about React.

Gatsby

To launch the app locally, run gatsby develop and open http://localhost:8000 to test the app or http://localhost:8000/\_\_\_graphql for the integrated Graph query tool.

Note: If using Edge or Chrome and you see an error about the site not being secure and the browser redirected you to https, open chrome://net-internals/#hsts, scroll down to the Delete domain security policies section, enter localhost into the textbox, and click Delete.

Edit the code in place and the browser should update automatically (no need to refresh). The default page is src/pages/index.js.

Other notable files include:

• gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.
• gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).
• gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
• gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

For more details, refer to the Gatsby tutorial and documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

Fluent UI

Learn more about Fluent UI.