Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.84 KB

README.md

File metadata and controls

53 lines (32 loc) · 1.84 KB

Dziknik

dziknik-logo

Dziknik is a comprehensive fitness platform designed for enthusiasts and professionals alike. It allows users to create, share, and follow training plans, ensuring a holistic approach to fitness. Whether you're looking to start your fitness journey or aiming to break your records, Dziknik is here to guide you.

Structure

The project is structured as a monorepo with two main directories:

  • backend: Contains the server-side code, API endpoints, and database interactions.
  • frontend: Houses the client-side code, user interface, and user experience components.

Features

  • User-Centric: Personalized dashboards, training plans, and exercise routines.
  • Collaborative: Share your training plans, get feedback, and collaborate with others.
  • Adaptable: Suitable for both beginners and seasoned fitness professionals.
  • Secure: Robust user authentication and data protection mechanisms.

Getting Started

Prerequisites

  • Node.js
  • PostgreSQL
  • Yarn package manager

Installation

  1. Clone the repository:
git clone https://github.com/KowalewskiPawel/Dziknik.git
  1. Navigate to the respective directory (backend or frontend) based on your needs.

  2. Follow the README.md instructions inside each directory for detailed setup and running instructions.

Contributing

Contributions to Dziknik are always welcome. Whether it's feature enhancements, bug fixes, or documentation improvements, your efforts are appreciated. Please fork the repository and create a pull request for any changes.

License

Dziknik is licensed under the Apache 2.0 License. Check out the LICENSE file for more details.

Acknowledgements

A special thanks to all contributors, supporters, and fitness enthusiasts who've made Dziknik possible.