/csc190-beam-team

Team Beam Team's final project.

Primary LanguageTypeScript

ARPF Map Companion

ARPF

Table of Contents

The Goal

image

image

Create a mobile application for the American River Parkway Foundation that provides users with a user-friendly and convenient way to access information about the Foundation and the American River Parkway. The mobile app will include a map feature, allowing users to easily locate and explore different areas of the parkway. The app will provide users with a wealth of information about the parkway, including trails, natural features, historical landmarks, and events. By creating a mobile app, the American River Parkway Foundation hopes to increase awareness and engagement among users, leading to increased support and preservation of this important natural resource.

About Project

In action

Tech Stack

  • Frontend
    • Languages: TailwindCSS, Typescript, and React Native JSX
    • SKDs: Expo, with Xcode or Android Studio for emulation
  • Backend
    • Server: Express JS
  • Database
    • Postgresql provided thorugh Supabase
  • API’s
    • Google Dynamic Maps

Environment Setup

Requirements:

VSCode plugins you'll probably want:

Useful tools:

  • act - Run your GitHub Actions locally

Download and Initialization

  1. Clone the codebase from the repo
git clone https://github.com/AndOrangutan/csc190-beam-team
  1. Add in .env environmental variable file to the root file directory, providing API Keys, IP, and Port.
code .env   # Create .env file and open it in vscode.

  1. Initialize the project, this installs the required libraries and builds the project (basically yarn install and yarn run build for both server and client)

    • Windows

      ./init.bat

    • Linux or MacOS

      ./init.sh

  2. Run the server from a terminal:

cd server
yarn run start

If you have made changes to the server, you will have to rebuild first running the following in the server directory:

yarn run build
  1. Open another terminal to the ROOT of the project and run the client:
yarn run start
  1. From here you should be prompted to open the app in an iOS Sim or Android Emulator.

Testing

Running test for the client can simply be done by calling:

yarn test

To run the server's, first change into the server directory.

cd server
yarn test

Contributors

Resources