Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Eye-Catchy README.md for users. #304

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 55 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
![image](https://user-images.githubusercontent.com/15027245/148551077-087685a0-8800-4a54-9a51-d02726dee916.png)

# Prerequisite
Ionic CLI - If you don't have the ionic CLI installed refer [official documentation](https://ionicframework.com/docs/intro/cli) for the installation instructions.

## Prerequisite 📱

# Build Notes (Users)
Make sure you have the Ionic CLI installed. If not, check out the [official documentation](https://ionicframework.com/docs/intro/cli) for installation instructions.

---

## 🛠️ Build Notes for Users

1. **Download** the app from the [release](https://github.com/hotwax/pickingapp/releases) page and extract it.
2. **Navigate** to the app directory.
3. Run the following command to download dependencies:
```bash
npm install

1. Download the app from [release](https://github.com/hotwax/pickingapp/releases) page and extract it.
2. Go to the app directory.
3. Run following command to download dependencies
`npm i
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)
# 👩‍💻 For Contributors

1. Open a Terminal window
2. Clone app using the command: `git clone https://github.com/hotwax/preorder.git <repository-name>`
Expand All @@ -24,77 +29,80 @@ Ionic CLI - If you don't have the ionic CLI installed refer [official documentat
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
# 🌐 Firebase Hosting 🌐

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

## Prerequisite
## 🔑 Prerequisite

- [Firebase Cli](https://firebase.google.com/docs/cli) should be installed
- Firebase project should be created
- You should have access to firebase project
- *Install the [Firebase Cli](https://firebase.google.com/docs/cli)
- Create a Firebase project.
- Ensure you have access to the project.

## Dev deployment
## 🚀 Dev Deployment Steps

- Update the DEV instance url at .env.production file
- 1. Update the DEV instance URL in the .env.production file.

- Build the application using following command
- 2. Build the application:
`ionic build`

- Login into firebase
- 3. Log in to Firebase:
`firebase login`

- Run following command to deploy to firebase hosting
- 4. Deploy to Firebase Hosting:
`firebase deploy --only hosting:<hosting url>`

## How to build application in different environment or modes(staging, production, qa, etc)?

As there is a bug in Ionic cli due to which we cannot pass flag variables for commands (See [#4669](https://github.com/ionic-team/ionic-cli/issues/4642)). To build application in different modes we need to use vue-cli-service to build and then use the built app using capacitor copy command further.
## 🌍 Building for Different Environments

Follow following instructions:
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 using vue-cli-service:
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 Android Studio / XCode project:
3. Open the project Android Studio or XCode:
ionic capacitor open android
ionic capacitor open ios

# Contribution Guideline

1. Fork the repository and clone it locally from the `main` branch. Before starting your work make sure it's up to date with current `main` branch.
2. Pick an issue from [here](https://github.com/hotwax/preorder/issues). Write in the issue comment that you want to pick it, if you can't assign yourself. **Please stay assigned to one issue at a time to not block others**.
3. Create a branch for your edits. Use the following branch naming conventions: **preorder/issue-number**.
4. Please add issue number to your commit message.
5. Propose a Pull Request to `main` branch containing issue number and issue title.
6. Use [Pull Request template](https://github.com/hotwax/preorder/blob/main/.github/PULL_REQUEST_TEMPLATE.md) (it's automatically added to each PR) and fill as much fields as possible to describe your solution.
7. Reference any relevant issues or other information in your PR.
8. Wait for review and adjust your PR according to it.
9. Congrats! Your PR should now be merged in!
🤝 Contribution Guidelines

If you can't handle some parts of the issue then please ask for help in the comment. If you have any problems during the implementation of some complex issue, feel free to implement just a part of it.
1. Fork the repository and clone it locally from the main branch. Ensure it’s up to date.
2. Pick an issue from [here](https://github.com/hotwax/preorder/issues) 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 template](https://github.com/hotwax/preorder/blob/main/.github/PULL_REQUEST_TEMPLATE.md)and 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!

## Report a bug or request a feature

Always define the type of issue:
* Bug report
* Feature request
## 🐞 Reporting Bugs or Requesting Features

While writing issues, please be as specific as possible. All requests regarding support with implementation or application setup should be sent to.
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!


# UI / UX Resources
You may find some useful resources for improving the UI / UX of the app <a href="https://www.figma.com/community/file/885791511781717756" target="_blank">here</a>.
# 🎨 UI/UX Resources

You can find helpful resources for improving the UI/UX of the app <a href="https://www.figma.com/community/file/885791511781717756" target="_blank">here</a>.

# 💬 Join the Community on Discord

Have questions or ideas? Join our <a href="https://discord.gg/SwpJnpdyg3" target="_blank">Discord channel</a>!

# Join the community on Discord
If you have any questions or ideas feel free to join our <a href="https://discord.gg/SwpJnpdyg3" target="_blank">Discord channel</a>

# The license
# 📄 License

Pre-order app is completely free and released under the Apache v2.0 License. Check <a href="https://github.com/hotwax/preorder/blob/main/LICENSE" target="_blank">LICENSE</a> for more details.
The Pre-order app is completely free and released under the Apache v2.0 License. Check out the <a href="https://github.com/hotwax/preorder/blob/main/LICENSE" target="_blank">LICENSE</a> for more details.

Thank you for being part of our community! Together, let’s make pre-ordering seamless! 🎊