WaterPal

Never out of water.

The Goal of WaterPal

We aim to help People in need calculate how much water they need for a trip.

Features

  • Prompt that takes in what kind of vacation you’re going to, with how many people
  • Output how much water you will need, as a total and per person as well
  • How much should you drink ideally
  • How much should you drink in danger

Technologies used

  • Vite
  • Vue 3
  • Tailwind CSS
  • GitHub
  • VSCode

Getting Started

You can find a hosted instance of WaterPal here or host one following the steps below.

Prerequisites

  • node.js (LTS recommended)
  • npm 
    $ npm install npm@latest -g
  • yarn 
    $ npm install --global yarn

Setup

Before you could do anything with the project, you should clone it from our GitHub repository. To do that, you have to run the following command:

$ git clone https://github.com/TibixDev/Waterpal.git

After you’ve cloned WaterPal, you have to go into the cloned directory and run

$ yarn
$ yarn dev

And there you have it! You just hosted an instance of WaterPal.

Build

  1. Clone the repo

    $ git clone git clone https://github.com/TibixDev/Waterpal.git

  2. Install NPM packages

    $ yarn install
# or
$ npm install

  3. Build the project

    $ yarn build

    or

    $ npm run build

  4. Deploy the dist folder or view it using live-server

  5. Enjoy!

Contributing

Contributions are what make the open source community such a great place in the online world. Any contributions are greatly appreciated.

If you have a suggestion you might want to share with the contributors of WaterPal, just open an Issue, or make a Pull Request!

Making a Pull Request

Making a Pull Request is pretty simple, just follow these steps:

  1. Clone the WaterPal repository: git clone https://github.com/TibixDev/Waterpal.git
  2. Make a new branch for your feature: git checkout -b MyNewFeature
  3. Commit your changes: git commit -m "My Amazing Commit Message"
  4. Push to your branch: git push -u origin MyNewFeature
  5. Open a Pull Request

License

WaterPal is distributed under the MIT License

For further information visit opensource.org.

Contact

GitHub

View Github