NotenApp

Manage your school and university grades.

📝 Table of Contents

• 📝 Table of Contents
• 🧐 About
• 🏁 Getting Started
  • Prerequisites
  • Installing
• 🔧 Running the tests
• 🎈 Usage
• ⛏️ Built Using

🧐 About

With this app you can organize your school and uni grades and view your current grade average.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Make sure you have installed Node.js and Yarn using Corepack (Good Guide). However when installing yarn with the guide linked above, don't run the command corepack enable npm because this will cause an issue when trying to build the app using Expo. If you have already run it, I see not other way besides reinstalling node unfortunately.

In case you want to know the details:
Expo will try to run the command npm view expo-template-bare-minimum@sdk-51 dist --json which will fail because the project is setup to use yarn and not npm. This only occurs when running the command mentioned above.

If you use VS Code, I recommend you add the Expo Tools VS Code extension.

If you want to generate the app builds using Expo EAS Build, you need to own an Expo Account and install the EAS CLI:

npm install -g eas-cli

Then log in to your Expo account:

eas login

For building the app locally see Expo - Local app development.

Installing

After cloning the repository, install the project's dependencies:

yarn

Build a development build of the app:

yarn build:eas-local-dev # Uses EAS locally (only on Linux/MacOS)

or:

yarn build:dev # Uses Expo Prebuild

Finally, start the development server (if it isn't already running):

yarn dev

The development build can now be installed on an emulator or actual device, if it isn't already, and it can connect to the development server.

🔧 Running the tests

To run all test suites, run:

yarn test

🎈 Usage

You can see your subjects and their grades at the center of the screen. At the bottom you can either add a new subject or swipe right on the grade to switch to another one.

⛏️ Built Using

• Expo - Mobile Framework and their packages
• Legend-State - State Management
• Jest - Testing Framework
• TypeScript - JS Static Typing