CodySly / King-Crawlers-App

0 stars 0 forks source link

Contributors Forks Stargazers Issues MIT License


![KingCrawlersTransparent](https://github.com/CodySly/King-Crawlers-App/assets/130408252/3eb55fc4-4ac5-4a65-955a-d8e0ec0508b4)

Rock Crawler 4x4 Trails App

Explore the docs »

Table of Contents
  1. About The Project
  2. Video Demo
  3. Screenshots
  4. Roadmap
  5. Getting Started
  6. Cloing the Repository to Contribute
  7. Installing a Test Version of the App on your Iphone
  8. Usage
  9. Contributing
  10. License
  11. Contact
  12. Application Project Disclaimer

About The Project

The King Crawlers App is designed to provide a seamless experience for 4x4 Rock Crawling Enthusiasts who want to explore the Registered Trails offered in the state of Utah "Currently". The King Crawler App is looking to provide users with a Map Location Base Service for you to navigate to one of many trails provided. Other features being add Personlized profile, message system, individual/group tracking, picture uploading, video uploading, friends and account management.

(back to top)

Developed With

(back to top)

Video Demo

URL:

ScreenShots

Roadmap

(back to top)

Getting Started

Setting Up Xcode on an iOS Device

Before you can use or contribute to the King Crawlers App project, you need to have Xcode installed on your iOS device. Here are the steps to set it up:

  1. Install Xcode:

    • Visit the App Store on your iOS device.
    • Search for "Xcode" and click on the Xcode app.
    • Tap the "Get" button to download and install Xcode.
  2. Developer Account:

    • To access all the features and testing capabilities of Xcode, consider signing up for an Apple Developer Account.
  3. Apple ID:

    • Ensure that you're signed in with your Apple ID on your iOS device.
  4. Enable Developer Mode:

    • Open Xcode and sign in with your Apple ID.
    • Go to Xcode Preferences > Accounts.
    • Click the "+" button and add your Apple ID.
    • Verify your account, and it should now be connected to Xcode.

Cloning the Repository to Contribute

Now that you have Xcode set up, you can clone the King Crawlers App repository and start contributing. Here are the steps to clone the repository:

  1. Fork the Repository:

    • Open your web browser and visit the King-Crawlers-App GitHub repository.
    • Click the "Fork" button in the upper-right corner. This will create a copy of the repository in your GitHub account.
  2. Clone the Forked Repository:

    • Open Xcode on your iOS device.
    • Go to Source Control > Clone.
    • In the "Clone Repository" dialog, enter the URL of your forked repository. It will be something like: https://github.com/yourusername/King-Crawlers-App.git.
    • Choose the local directory where you want to save the project.
    • Click "Clone."
  3. Create a New Branch:

    • Open the cloned project in Xcode.
    • Go to Source Control > Create Branch.
    • Name your branch and select the base branch you want to work on (usually "main" or "develop").
  4. Make Changes:

    • Make the necessary code changes or additions in your branch.
  5. Commit Changes:

    • Go to Source Control > Commit.
    • Enter a commit message describing your changes and commit them.
  6. Push Changes:

    • Go to Source Control > Push to push your changes to your forked repository on GitHub.
  7. Create a Pull Request:

    • Visit your forked repository on GitHub.
    • Click the "New Pull Request" button.
    • Choose the base repository (the original King Crawlers App repository) and the base branch (e.g., "main" or "develop").
    • Choose your forked repository and the branch you made changes in.
    • Provide a title and description for your pull request.
    • Click "Create Pull Request."

That's it! You've successfully cloned the repository, made changes, and created a pull request to contribute to the King Crawlers App project.

(back to top)

Installing a Test Version of the App on Your iPhone

If you want to run the app on your own iPhone for testing or development purposes, follow these steps. This process is often referred to as "sideloading" the app onto your device.

Prerequisites

Step 1: Set Up Xcode

  1. Open Xcode on your Mac.

  2. Ensure that your Xcode is configured with your Apple Developer account. To do this:

    • Go to Xcode Preferences.
    • Under the "Accounts" tab, click the "+" button and sign in with your Apple Developer account.

Step 2: Configure Your iPhone

  1. Connect your iPhone to your Mac using a USB cable.

  2. In Xcode, open your project by selecting the appropriate workspace or project file.

  3. Select your iPhone as the deployment target. To do this:

    • Click on the device name in the top toolbar (e.g., "Generic iOS Device").
    • Choose your iPhone from the list.

Step 3: Build and Install

  1. In Xcode, press the "Play" button (or use Cmd+R) to build and run the app on your iPhone. Xcode will compile the app and install it on your device.

  2. The app will appear on your iPhone's home screen, and you can launch it like any other app.

Step 4: Trust the Developer Certificate

The first time you run the app on your device, you may encounter an "Untrusted Developer" error. To resolve this:

  1. On your iPhone, go to Settings > General > Device Management (or "Profiles & Device Management").

  2. Under the "Developer App" section, tap your Apple ID and trust the developer certificate associated with your account.

Step 5: Run the App

You should now be able to run and test the app on your iPhone. Any changes you make in Xcode and re-run the app will be reflected on your device.

Remember that you'll need to repeat these steps each time you update the app in Xcode or if you reinstall it after a certain period, as the developer certificate may expire.

Note: This guide covers the basic steps for sideloading an app during development. To distribute the app to a wider audience, you would need to follow Apple's guidelines for App Store distribution or use TestFlight for beta testing.

Usage

The King Crawlers App is designed to provide a seamless experience for 4x4 Rock Crawling Enthusiasts who want to explore the Registered Trails offered in the state of Utah "Currently". The King Crawler App is looking to provide users with a Map Location Base Service for you to navigate to one of many trails provided. Other features being add Personlized account profile, message system, individual/group tracking, picture uploading, video uploading, friends, and account management. Here's how to use the app effectively:
** Some features of the app have not been implemented yet and will be in further Version of the app. Please refer to the RoadMap section to see what feature and version the app is currently on.

1. Launch the App

2. Explore Products

3. Add Items to Your Cart

4. Registration and Login

5. Manage Your Cart

6. Checkout and Payment

7. View Order History

8. Notifications

9. Enjoy Your Fruiteria Experience

The Fruiteria iOS app is designed for a convenient and delightful customer experience. If you encounter any issues or have questions, please refer to the "Contact" section in the README to get in touch with the app's support team.

(back to top)

License

Distributed under the None License. See LICENSE.txt for more information.

(back to top)

Contact

Cody Sly - codysburgess@gmail.com

Discord - codysly

Project Link: https://github.com/CodySly/King-Crawlers-App

(back to top)

Application Project Disclaimer

Note: This disclaimer is intended to inform users of our application (the "King Crawler App") about its limitations, responsibilities, and use. By using the Application, you agree to abide by the terms outlined in this disclaimer. If you do not agree with these terms, please refrain from using the Application.

No Warranties

The Application is provided "as is" without any warranties, expressed or implied. We do not warrant or guarantee the accuracy, reliability, or completeness of the information or content provided within the Application. We disclaim all warranties, including but not limited to:

Limitation of Liability

In no event shall we be liable for any direct, indirect, special, incidental, or consequential damages arising out of the use or inability to use the Application. This includes but is not limited to damages for loss of data, profits, business, or personal harm, even if we have been advised of the possibility of such damages.

Information Accuracy

While we strive to provide accurate and up-to-date information within the Application, we do not guarantee the correctness of the content. Users are responsible for verifying any information obtained from the Application before making decisions based on that information.

Third-Party Content

The Application may contain links to third-party websites, services, or content that are not owned or controlled by us. We do not endorse, warrant, or guarantee the accuracy of any third-party content, and we are not responsible for your interactions with such content or services.

Privacy and Data Security

We are committed to safeguarding your privacy and the security of your data. Please refer to our Privacy Policy for information on how we collect, use, and protect your personal information.

Changes and Updates

We reserve the right to modify, update, or discontinue the Application at any time without notice. We may also change the terms of this disclaimer. It is your responsibility to review this disclaimer periodically for any updates or changes.

Jurisdiction and Applicable Law

This disclaimer shall be governed by and construed in accordance with the laws of [Your Jurisdiction]. Any disputes arising from the use of the Application shall be subject to the exclusive jurisdiction of the courts in [Your Jurisdiction].

Contact

If you have any questions, concerns, or feedback regarding this disclaimer or the Application, please contact us at.

(Contact)

[End of Disclaimer]

By using the Application, you acknowledge and agree to the terms and conditions outlined in this disclaimer. Your use of the Application is subject to these terms, and any disputes arising from such use shall be governed by the applicable laws of your jurisdiction.

(back to top)