Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 3.75 KB

README.md

File metadata and controls

108 lines (66 loc) · 3.75 KB

image

Prerequisite 📱

Make sure you have the Ionic CLI installed. If not, check out the official documentation for installation instructions.

Build Notes for Users 🛠️

  1. Download the app from the release page and extract it.
  2. Navigate to the app directory.
  3. Run the following command to download dependencies: 
    npm install
  4. Create a .env file by taking reference from the .env.example.
  5. To run the app in browser use the command: ionic serve

Build Notes (Contributors) 🛠️

  1. Open a Terminal window
  2. Clone app using the command: git clone https://github.com/hotwax/preorder.git <repository-name>
  3. Go to the directory using command: cd <repository-name>
  4. Run following command to download dependencies npm i
  5. Create a .env file by taking reference from the .env.example.
  6. To run the app in browser use the command: ionic serve

Firebase Hosting 🌐

We're using Firebase Hosting for the Pre-order app deployment. Here’s how to deploy:

Prerequisite

  • *Install the Firebase Cli
  • Create a Firebase project.
  • Ensure you have access to the project.

Dev Deployment Steps

    1. Update the DEV instance URL in the .env.production file.
    1. Build the application: ionic build
    1. Log in to Firebase: firebase login
    1. Deploy to Firebase Hosting: firebase deploy --only hosting:<hosting url>

🌍 Building for Different Environments

Due to a bug in the Ionic CLI, we need to use vue-cli-service for building different modes (staging, production, QA, etc.):

  1. Manually build the application: npx vue-cli-service build --mode=sandbox

  2. Copy web assets to the native project without building the app: ionic capacitor copy ios --no-build

  3. Open the project Android Studio or XCode: ionic capacitor open android
    ionic capacitor open ios

Contribution Guideline

🤝 Contribution Guidelines

  1. Fork the repository and clone it locally from the main branch. Ensure it’s up to date.
  2. Pick an issue from here and comment if you want to take it on. Stay assigned to one issue at a time to avoid blocking others.
  3. Create a branch for your edits using the naming convention: preorder/issue-number. Add the issue number to your commit message. Propose a Pull Request to the main branch with the issue number and title. Use the Pull Request templateand fill in as much detail as possible. Reference any relevant issues or information in your PR. Wait for a review and adjust your PR as needed. Congrats! 🎉 Your PR should now be merged! If you encounter any issues or need help, feel free to ask!

🐞 Reporting Bugs or Requesting Features

Always specify the type of issue:

Bug report Feature request Be as specific as possible when writing issues. For implementation support or setup questions, reach out to the community!

U🎨 UI/UX Resources

You can find helpful resources for improving the UI/UX of the app here.

💬 Join the Community on Discord

Have questions or ideas? Join our Discord channel!

📄 License

The Pre-order app is completely free and released under the Apache v2.0 License. Check out the LICENSE for more details.