Skip to content

VitorLelis/neptune

Repository files navigation

Neptune

Neptune is a mobile app built with Expo, React Native, and TypeScript that serves as a swimming team manager. It allows coaches and team managers to register swimmer information and times, form the best relay teams, rank swimmers by event, and convert times across courses.

Table of Contents

Features

  1. Swimmer Registration: Easily register swimmers with personal details and best times.
  2. Best Relay Calculator: Select the best possible relay team of four swimmers based on time and event.
  3. Swimmer Rankings: View rankings of the top swimmers for each event.
  4. Time Converter: Convert swim times for events and adjust for different course lengths (e.g., short course meters, long course meters).

Installation

  1. Clone the Repository:

    git clone https://github.com/VitorLelis/neptune.git
    cd neptune
  2. Install Dependencies: Ensure you have Node.js and Expo installed. Then install dependencies:

    npm install
    # or
    yarn install
  3. Run the Development Server: Start the Expo server:

    npx expo start
  4. Run on Device: Scan the QR code with the Expo Go app (iOS and Android) or use an emulator (iOS requires macOS).

Contributing

We welcome contributions to improve Neptune! To contribute:

  1. Fork the repository and clone it locally.
  2. Create a new branch for your feature or bugfix:
    git checkout -b feature-name
  3. Commit your changes:
    git commit -m "Add new feature or fix"
  4. Push your branch to GitHub:
    git push origin feature-name
  5. Open a Pull Request on the original repository.

About

Swimming Team Manager 🏊‍♂️

Resources

License

Stars

Watchers

Forks

Packages

No packages published