Eon English App

Table of Contents

• About The Project
  • Built with
• Instructions
  • Courses and Tools
  • Access our Figma Design
• How to Contribute

About The Project

The Eon English App serves as a bridge between classroom learning and practical application, empowering students to achieve their educational goals with ease.

The app is designed to support Eon students in their learning journey by providing a seamless way to access and complete their homework. This app complements the concepts taught during tutor sessions, enabling students to practice and reinforce their learning.

Key Features:

• A vast collection of short questions and interactive quizzes to help students retain knowledge effectively.
• A user-friendly interface to make homework submission and progress tracking effortless.
• Tools to ensure students apply what they learn, fostering better understanding and retention.

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)

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!

Any contributions you make are greatly appreciated!

1. Fork or Create a Branch

• Begin by forking the repository or creating a branch from the GitHub Repo.

2. Set Up Your Environment

Ensure you have the following installed:

• 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

3. Get Access to ENV Keys

• Join our Discord channel and contact @Tech_Manager.
• Share your GitHub email to gain access to the application's secrets.

After cloning the repository from Github Repo, initialize the Git submodules with:

git submodule update --init --recursive  

To ensure your .env keys stay updated, use:

git submodule update --remote --recursive  

Not working? Find the secret keys here...

4. Pick a Task

• Visit the Planning Tab on GitHub.
• Assign a task to yourself or create one and assign it to yourself.
• Once assigned, start working on your task.

5. Submit a Pull Request

• Once your task is completed, commit and push your changes to your branch.
• Go to the repository and create a Pull Request (PR) with a detailed description of the changes.
• Mention the issue or task you were working on (if applicable). Wait for the code review.
• If changes are requested, make the updates and push them to the same branch.
• Once approved, your PR will be merged into the main branch.

6. Team Meetings

• We hold team meetings biweekly on Sundays.
• The meeting link can be found on Discord.

Feel free to reach out on Discord if you have any questions or need guidance. Happy contributing!