Notecards

Notecards

A React Native with TypeScript project

Report Bug · Request Feature · Documentation

Table of Contents

1. About The Project
   • Built With
2. Run The App Locally
   • Prerequisites
   • Installation
3. Contact
4. Acknowledgments

About The Project

This is the User Interface of the Notecards Application. The application is used to create, display, and manage sets of Notecards as well as to track a Users activity. The corresponding REST API is located in the notecards-server repository

(back to top)

Built With

The Notecards User Interface is built with TypeScript and React Native. It uses Expo to assist with the development and deployment of the mobile application. The User Interface uses the React Navigation library for routing. The React Native Elements library is used to provide components with consistent styles and functionality.

• 

(back to top)

Run The App Locally

Prerequisites

Download the Expo Application (SDK: 51, client version: 2.31.1) on your mobile device

Installation

1. Clone the repo

   git clone https://github.com/jakewhite8/Notecards.git

2. Using node version 16.20.2 and npm version 8.19.4, install NPM packages

   npm install

3. Start the application

   npm start

   Note the URL provided beginning with exp (ex: exp://10.0.0.84:8081)
4. Open the Expo application on your mobile device. Enter the URL provided in the previous step and press connect. After a brief loading period (~30 seconds), the Login page of the Notecard application should be displayed

(back to top)

Contact

Jake White - [email protected]

Project Link: https://github.com/jakewhite8/Notecards

(back to top)

Acknowledgments

Resources I found helpful and would like to give credit to

• Img Shields
• Best-README-template

(back to top)