Read in other languages: English, Ukrainian.

Byte My Water App

Description

Byte My Water App is a modern web application designed to manage water consumption and related tasks efficiently. The application provides users with a user-friendly interface to track their water usage, set goals, and receive notifications. Whether you're a homeowner, a business owner, or simply concerned about water conservation, Byte My Water App is here to help you manage your water consumption effectively.

Technologies Used

• Frontend:
  • React: A JavaScript library for building user interfaces.
  • React Router: A routing library for React applications.
  • Material-UI: A popular React UI framework for designing responsive web applications.
  • Styled Components: A CSS-in-JS library for styling React components.
  • Axios: A promise-based HTTP client for making AJAX requests.
  • React Hook Form: A library for managing form state in React applications.
  • Redux Toolkit: A Redux utility belt for efficient Redux development.
  • React Redux: Official React bindings for Redux.
  • React Responsive: A library for building responsive React applications.
  • React Select: A flexible and beautiful Select Input control for ReactJS.
  • React DatePicker: A simple and reusable datepicker component for React.
  • React Toastify: A toast notification library for React applications.
  • i18next: A powerful internationalization framework for JavaScript.
• Backend:
  • "https://byte-water-back.onrender.com/api-docs"
• Build Tools:
  • Vite: A fast build tool that significantly improves frontend development experience.
• Linting & Formatting:
  • ESLint: A tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
  • Prettier: An opinionated code formatter.

Installation

1. Clone the repository:

git clone https://github.com/Elizabethhub/byte-my-water-app.git

2. Navigate to the project directory:

cd byte-my-water-app

3. Install dependencies:

npm install

4. Start the development server:

npm run dev

5. Open your browser and visit http://localhost:5173 to view the application.

Usage

• Upon launching the application, users are prompted to sign up or log in.
• Once logged in, users can:
  • View their water consumption statistics.
  • Set water consumption goals.
  • Receive notifications regarding their water usage.
  • Perform various other tasks related to water management.

Team Developers

• Yelyzaveta Kudelia - Fullstack Developer/Team lead, Modal Norma module
• Oleh Opolonets - Fullstack Developer/Scrum Master, Today & Calendar modules
• Dmytro Prymachenko - Fullstack Developer, Welcome page & Header modules, Language, Theme
• Kirra Potiekhina - Fullstack Developer, Modal add/edit modules
• Victor Filinovych - Fullstack Developer, User settings module
• Yehor Hryhortsev - Fullstack Developer, Authorization module
• Anastasiia Farafonova - Fullstack Developer, Today layout

Contributing

We welcome contributions from the community! If you find any bugs or have suggestions for improvement, please feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.