Hide and Seek Project

Welcome to the UF Open Source Club's "Hide and Seek" Project. An app that allows you to play Hide and Seek across campus in the style of Jetlag!

If you want to get started contributing, check out our documentation!

Helpful Links

🖌️ Figma Mockup

📖 Documentation

Project Structure

This repo contains three main folders: docs, mobile, and supabase

|-- docs/             # Next.js docs project using Nextra for documentation
|   |-- pages/        # Documentation pages
|
|-- mobile/           # Mobile app project (React Native)
|   |-- components/   # UI components (e.g., HelloWave.tsx)
|   |-- ...other code...
|
|-- supabase/         # Supabase backend functions and configuration
|   |-- functions/    # Database triggers and API functions
|   |-- ...other code...
|
|-- package.json      # Root project configuration for prettier only (as of right now)
|-- ...other files...

Running the mobile app, server, and docs

1. Install the package manager, yarn (must be version 1)

npm install -g yarn@1

1. Install dependencies

yarn install

2. Start the program

yarn run dev

You can also run each package separately with the following commands:

• To run the docs project:

  yarn run dev:docs
  

• To run the mobile app:

  yarn run dev:mobile
  

• To run the supabase server:

  yarn run dev:supabase
  

Adding to the documentation

Edit Markdown files in the pages/ directory. Your changes will be live-reloaded by Nextra.

Code Formatting & Linting

Each project adheres to consistent code style. Each time before you push changes, run the following commands:

Prettier

• Prettier will automatically format your code so our project has consistent formatting and line spacing

• To format your code using Prettier in the project, run the following commands in the root project directory:

  npx prettier --write .
  

Linting

• The linter ensures that your code does not have any errors.

• To run the linter for the mobile app or docs project, use:

  yarn run lint
  

Happy coding and thanks for contributing!