Eon-English-App

Table of Contents

• About The Project
  • Built with
• Instructions
  • Courses and Tools
  • How to Run the App
  • How to Access our ENV Keys
  • How to Access our Figma Design
• How to Contribute

About The Project

This app will help Eon students find their homework and apply what they have learned during tutor sessions. It is filled with many short questions and quizzes to help them retain information.

Built With

• 
• 
• 
• 
• 

Instructions

The project uses React Native and requires some knowledge of JavaScript. Therefore, we recommend building foundational knowledge. The materials we provide are optional.

Courses and Tools

• Codeacademy's React Native Course

• Codeacademy's JavaScript Course

• Visual Studio Code (Editor)

  • Android Studios (universal emulator)
  • VS Code Emulator Plug-in
  • Prettier Plug-in (formatter)

How to Run the App

We use React Native and Expo's CLI to run the application locally. You may use the following guides for your operating system.

• Set up React Native environment (MacOS)

  • Run our app locally using Xcode/Android Studios

• Set up React Native environment (Windows)

  • Set up Android Studios Windows

How to Access our ENV Keys

For the initial start up, run the following submodule command to retrieve the .env keys (requires repository access)

git submodule update --init --recursive

To keep your keys updated, run the following command

git submodule update --remote --recursive

Not working? Find the secret keys here...

How to Access our Figma Design

You will have permission to view the document. If you would like to make direct changes, contact a team manager for write permissions.

• Figma Design

How to Contribute

Contributions are what make this community such an amazing place to learn, inspire, and create! There are a many ways you can help

• Did you spot any errors?
• What features could we add?
• What would improve the app?
• How can we work better as a team?

Any contributions you make are greatly appreciated!