Skip to content

code4recovery/oiaa-direct

Repository files navigation

OIAA Direct (oiaa-direct)

Version of OIAA's Online Meeting List that queries meeting data from the data source through central-query.


Project Overview

OIAA Direct is a React + TypeScript + Vite application for browsing and searching online meetings. It fetches meeting data from a central-query API and provides filtering, search, and group information features.


Quick Start

git clone https://github.com/your-org/oiaa-direct.git
cd oiaa-direct
npm install
Configure `.env`
npm run dev

Setup

  1. Clone the repo to a folder of your choice.
  2. Run npm install from that folder.
  3. Update .env environment variables as needed.

Required Environment Variable

VITE_CQ_URL="https://central-query.apps.code4recovery.org/api/v1/meetings"

Recommended VS Code Extensions

The repo includes config files for each of these plugins.


React Router

This project relies heavily on the React Router framework (currently version 7.x).

  • Route Types:
    Always use the types and utilities provided by React Router v7 for generating and maintaining route types.
    Avoid hardcoding route paths or types—leverage the framework’s helpers and conventions for consistency and type safety.

  • Upgrading:
    If upgrading React Router, review the migration guides and update route types, navigation, and related logic accordingly.

Refer to the official React Router documentation for version-specific APIs and best practices.



Folder Structure

src/
  components/      # React components
  utils/           # Utility functions
  meetingTypes.ts  # TypeScript types
  getData.ts       # Data fetching logic
public/
.env
package.json

Testing

To run tests (if available):

npm test

Contributions

Please follow the Udacity Guide for commit messages.
If committing code for a feature that is not complete, add (wip) to the title.
Example: feat: (wip) Add React Router to fetch meeting data.


React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

License

MIT


Support

For questions or support, please open an issue or contact the maintainers.

About

Version of OIAA's Online Meeting List that queries meeting data directly from the database.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •