Skip to content

scottcl88/shark-tooth-tracker-app

Repository files navigation

Shark Tooth Tracker App

Description

The Shark Tooth Tracker App is a web/mobile application that allows users to track and catalog their shark tooth collections. Users can add new shark teeth to their collection, and view details about each tooth.

sharktoothtracker.com | Play Store | App Store

Features

  • Add new shark teeth to your collection
  • View details about each tooth, including species, size, and location found
  • Track the date and location where each tooth was found

Packages and Tools Used

The Shark Tooth Tracker App utilizes the following packages and tools:

  • Angular v17
  • Ionic v7
  • Capacitor v5
  • Firebase
  • Google Maps Places Api

These packages and tools contribute to the development, testing, and overall quality of the Shark Tooth Tracker App.

SonarCloud Integration

We have integrated SonarCloud into our development process to ensure code quality and identify potential issues. SonarCloud performs static code analysis and provides valuable insights into code smells, bugs, vulnerabilities, and more. To view the latest analysis report and track any issues, please visit our SonarCloud Dashboard.

Installation

  1. Clone the repository: git clone https://github.com/scottcl88/shark-tooth-tracker-app.git
  2. Install dependencies: npm install
  3. Start the development server: npm start

Usage

  1. Open the application in your web browser.
  2. Sign up or log in to your account.
  3. Start adding shark teeth to your collection.
  4. Explore and search your collection using the provided features.

Contributing

Contributions are welcome! If you would like to contribute to the Shark Tooth Tracker App, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the main repository.

When making changes to the Shark Tooth Tracker App, please ensure that you watch for any issues identified by SonarCloud. Before submitting a pull request, make sure to address any code quality issues or bugs reported by SonarCloud. This will help maintain the overall quality and stability of the application.

License

This project is licensed under the MIT License.

Contact

If you have any questions or suggestions, please feel free to contact the project maintainer at [email protected].