Skip to content

Latest commit

 

History

History
149 lines (105 loc) · 4.8 KB

README.md

File metadata and controls

149 lines (105 loc) · 4.8 KB

Contributors Forks Stargazers Issues MIT License


Logo

Hackipups

Award-winning, gluten-free and open-source app made to bring you closer to your partner and care for each others' health by petting a Tamagotchi-style virtual doggo.
Try it out! · Report Bug(s)

Table of Contents
  1. About
  2. Getting Started
  3. Idea
  4. Roadmap
  5. Achievements
  6. Contributing
  7. License

About

Hackipups is a web application built on Next.js, it allows you to pet a virtual animal with your closest friend, partner or favorite family member. By this, you can have another great activity to do together, and specially, care each other's health.

You can also check out the API's codebase at https://github.com/ulisesvina/hackipups-api

Built With

  • Javascript
  • Next.js
  • Capacitor (for the mobile client)
  • React
  • Vercel

(back to top)

Getting Started

You can either compile and build your own version of hackipups or use the existing client.

Prerequisites

  • node
  • yarn

Building

  1. Install the required software listed in prerequisites.
  2. Clone the repo 
    git clone https://github.com/ulisesvina/hackipups.git
  3. Run the compiler 
    yarn run build

(back to top)

Idea

Name

Hackipups comes from "hack" and "pups", this is because originally Hackipups was a hackathon project for MLH's Hack or Treat 2, the team behind Hackipups won the Mom's Spaghetti prize and wanted to continue on with the project.

Mascot

Sheldon, the mascot of Hackipups was named by the lead maintainer's girlfriend after the The Big Bang Theory's character, Sheldon Cooper.

(back to top)

Roadmap

  • Functioning client
  • API
  • Real-time functionality using websockets

See the open issues for a full list of known issues.

(back to top)

Achievements

  • Winners of the "Mom's Spaghetti" prize of Hack or Treat 2 by the Major League Hacking (MLH)
  • Working client with responsive layout

Contributing

Contributing to Hackipups is very easy and appreciated. Here are the instructions on how to do so

  1. Fork the project
  2. Create your changes branch (git checkout -b changes/Feature)
  3. Commit your changes (git commit -m 'Added bugs')
  4. Push to the branch (git push origin changes/Feature)
  5. Open a Pull Request (Here)

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)