Welcome to the repository for the official Hackapet website (hackapet.org)! This project serves as the main online portal for Hackapet, an open-source initiative dedicated to developing software that supports animal shelters, streamlines their operations, and facilitates pet adoption.
Live Site: https://hackapet.org
This website is built using Next.js and React. It is designed to clearly communicate Hackapet's mission, showcase our team and projects, and provide resources for shelters, contributors, and anyone interested in animal welfare through technology.
The core purposes of this website are to:
- Clearly articulate Hackapet's Mission: Improving the lives of animals in shelters by optimizing adoption and management processes with technological solutions.
- Introduce the Hackapet Team: A passionate group of volunteer developers, designers, and managers.
- Serve as a hub for information on our Software Projects aimed at animal shelters.
- Explain how to Collaborate and Contribute to our open-source efforts.
- Highlight our Open-Source and Altruistic Nature, with all work under a GPL license.
- Mission & Vision: Detailed information about Hackapet's goals and commitment to animal welfare.
- Team Showcase: Introduction to the core team members and their roles.
- Project Information: (This section will grow to detail specific software like PetSync, PetMatch, AdopTrack as they are featured).
- Contribution Guidelines: Links and information for prospective contributors.
- Responsive Design: Accessible on various devices.
- Multilingual Support: Content provided in Spanish and Valencian/Catalan to serve our local community and beyond.
- Built with Next.js for a fast, modern, and scalable user experience.
- Next.js - The React Framework for Production.
- React - A JavaScript library for building user interfaces.
To get a local copy up and running, follow these simple steps.
- Node.js: Ensure you have Node.js installed (which includes npm). We recommend using the latest LTS version. You can download it from nodejs.org.
- Yarn (Optional): If the project uses Yarn as a package manager, install it globally:
npm install --global yarn
-
Clone the repository:
git clone [https://github.com/hackapet-project/landing-page.git](https://github.com/hackapet-project/landing-page.git) cd hackapet-website -
Install dependencies: Using npm:
npm install
Or, if the project uses Yarn:
yarn install
-
Run the development server: Using npm:
npm run dev
Or, if using Yarn:
yarn dev
Open http://localhost:3000 (or the port specified in your console) with your browser to see the result.
-
Build for production: To create an optimized production build: Using npm:
npm run build
Or, if using Yarn:
yarn build
This will typically generate the build in a
.nextfolder.
Hackapet thrives on community contributions. We welcome developers, designers, writers, and anyone passionate about animal welfare to help us improve and expand our projects.
Please review our general contribution guidelines (link to your actual general contribution guidelines, if it exists) and any specific guidelines within this repository.
If you're looking to contribute to this website, you might consider:
- Improving content, translations, or accuracy.
- Enhancing components or adding new, relevant sections.
- Reporting bugs or suggesting UI/UX enhancements via Issues.
- Helping to keep documentation up to date.
To make changes:
- Fork the Project.
- Create your Feature Branch (
git checkout -b feature/YourAmazingFeature). - Commit your Changes (
git commit -m 'Add some YourAmazingFeature'). - Push to the Branch (
git push origin feature/YourAmazingFeature). - Open a Pull Request for review.
Distributed under the GPL License. See the LICENSE file in the repository for more information.
Hackapet is a GPL work by Hackapet. Made with ❤️ for animals.
We're here to help and welcome new contributors!
- GitHub Issues: Report bugs or suggest features for the website here.
- Hackapet Community:
- Join our Matrix channel (link can be found on the main Hackapet community page or contribute.md).
- Participate in GitHub Discussions (if applicable, link to the central discussions forum for Hackapet).
- Ask during our weekly meetings (details in the main Hackapet community resources).
Thank you for your interest in the Hackapet website. Together, we can make a bigger impact for animal shelters and the animals they care for! 🐱🐶