An open API service indexing awesome lists of open source software.

https://github.com/amadeuszblanik/wolfie-app

Web version of Wolfie application
https://github.com/amadeuszblanik/wolfie-app

dog next-js react react-js

Last synced: about 1 month ago
JSON representation

Web version of Wolfie application

Awesome Lists containing this project

README

          

# Wolfie.app
A Next.JS pet companion web application for dog owners.

## Table of Contents
1. [Official website](#official-website)
2. [License](#license)
3. [Authors](#authors)
4. [Support](#support)
5. [About the project](#about-the-project)
6. [Technologies](#technologies)
7. [Installation](#installation)
8. [Usage](#usage)
9. [Contributing](#contributing)

## Official website
* [Stable build](https://wolfie.app)
* [Development build](https://next.wolfie.app)
* [Doggo Open API](https://api.wolfie.app)

## License
[GPL v3](https://github.com/amadeuszblanik/wolfie-app/blob/main/licence)

## Authors
* [**Amadeusz Blanik**](https://blanik.me) - Frontend, Mobile, and Backend

## Support
Support me by buying me a tea or contributing to the project:
[Revolut](https://revolut.me/blanik)

## About the project
After becoming a proud dog dad of a Standard Schnauzer in 2022, I searched for an application to help me manage standard dog care tasks such as health, weight, feeding, and heat tracking. Since I couldn't find a suitable app, I decided to create one as an open-source project, hoping it would be useful for other dog owners.

Additionally, this project provided a great opportunity to learn more about SwiftUI, Nest.JS, and test new technologies.

## Technologies
#### Frontend
* [Next.JS](https://nextjs.org/)
* [React](https://reactjs.org/)
* [React-Query](https://react-query.tanstack.com/)
* [TypeScript](https://www.typescriptlang.org/)

#### Backend
* [NestJS](https://nestjs.com/)
* [NodeJS](https://nodejs.org/en/)
* [TypeScript](https://www.typescriptlang.org/)
* [TypeORM](https://typeorm.io/#/)

#### Mobile
* [SwiftUI](https://developer.apple.com/xcode/swiftui/)

Feel free to contact me with suggestions or ideas:
- [LinkedIn](https://www.linkedin.com/in/amadeuszblanik/)
- [Email](mailto:amadeusz@blanik.me)

## Installation
Use the package manager [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com) to install all dependencies.

For npm:

```bash
npm install
```

For yarn:

```bash
yarn install
```

## Usage

* `npm run dev` or `yarn dev` - starts the application in development mode.
* `npm run build` or `yarn build` - builds the application.
* `npm run start` or `yarn start` - starts the application in production mode.
* `npm run lint` or `yarn lint` - runs linter.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.