Hackipups API

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) · Client

Table of Contents

1. About
   • Built With
2. Getting Started
   • Prerequisites
   • Building
3. Idea
• Name
• Mascot
4. Roadmap
5. Achievements
6. Contributing
7. License

About

Hackipups is a mobile application based on Express, Prisma, Socket.io, 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 client's codebase at https://github.com/ulisesvina/hackipups

Built With

• Javascript
• Express
• Prisma
• Socket.io

(back to top)

Getting Started

You can either compile and build your own version of hackipups-api 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-api.git

3. Run the compiler

   yarn run build

(back to top)

Idea

Name

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

Mascot

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

(back to top)

Roadmap

• Functioning CRUD
• Auth
• JWT Implementation
• 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-api 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)