Skip to content

stephenlunt/msc-dissertation-scenic-rides

Repository files navigation

Scenic Rides

Scenic Rides is a mobile guidebook for scenic bus routes in the North East of England. It's a React Native project for iOS and Android mobile devices.

Update (2024-01-19): The write-up for this dissertation project in now published on my personal blog.

Project Commands

Before running the project, you must have the core dependencies installed. This includes Node.js and an emulator (such as Xcode or Android Studio). npm install is required before first-run.

Development environment

To start a development environment run the following commands:

  • Android: npm run android
  • iOS: npm run ios

The development app can be access through an emulator or the Expo Go mobile app.

Testing

Use the following command to run Jest unit tests:

  • Testing: npm test

Build

Documentation on the Expo build process is located here: https://docs.expo.dev/build/setup/

  1. Install the EAS CLI: npm install -g eas-cli

  2. Login to an Expo account: eas login

  3. Configure the build: eas build:configure

  4. Run a build: eas build --platform all

    • Android only: eas build --platform android

    • iOS only: eas build --platform ios (Note: this requires a paid Apple Developer account to complete)

  5. Deploy or run locally on an emulator.

    • Run the build on an Android emulator: eas build:run -p android

Project structure

$ ROOT
│   # Application entrypoint
├── App.tsx
│
│   # Source code files
├── src
│   │   # Assets compiled into the application
│   ├── assets
│   │   # Reusable React components
│   ├── components
│   │   # Application data store
│   ├── data
│   │   # Application screens (pages)
│   ├── screens
│   │   # Helper functions
│   └── util
│
│   # Configuration files
├── .prettierrc.js
├── app.json
├── babel.config.js
├── package.json
└── tsconfig.json

File Header Template

/**
 * Last modified: XX-XX-XXXX
 * Modifying author: ...
 * File description: ...
 */

Open Source Libraries and Accreditations

Open source software used in the production of this application:

The following accreditations represent a complete list of sources and tools that were used for production of content (text, images, maps, data points) for this application:

About

My masters dissertation project

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published