Git Product home page Git Product logo

nightven / agua_vivo_app_backend Goto Github PK

View Code? Open in Web Editor NEW
6.0 1.0 0.0 465 KB

Backand для застосунку Water app. Frontend: https://github.com/ServerIbraimovUa/agua_vivo_app

Home Page: https://agua-vivo-app-backend.onrender.com/api-docs/

License: MIT License

JavaScript 100.00%
bcryptjs cors expressjs gravatar joi jwt-authentication mongodb mongoose morgan nodejs swagger claudinary google-auth sendgrid

agua_vivo_app_backend's Introduction

Опис проєкту

Цей репозиторій містить бекенд частину додатку Agua Vivo, розробленого для Agua Vivo App (GitHub: Frontend)

Вимоги до середовища

  • Node.js
  • Express.js
  • dotenv
  • cors
  • MongoDB
  • Mongoose
  • SendGrid
  • Axios
  • bcrypt
  • cloudinary
  • gravatar
  • nanoid
  • Joi
  • Jsonwebtoken
  • Morgan
  • query-string
  • Multer
  • swagger-ui-express

Інструкції з встановлення

  1. Клонуйте репозиторій
git clone https://github.com/nightven/agua_vivo_app_backend.git

## Інструкції з встановлення

1. Клонуйте репозиторій

```bash
git clone https://github.com/nightven/agua_vivo_app_backend.git
  1. Встановіть залежності
npm install
  1. Додайте файл .env з необхідними змінними. Необхідні змінні можна побачити в файлі EXAMPLE.ENV
4. Запустіть сервер
```bash
npm run dev

Інструкції з використання

На нашому бекенді передбачено 4 основних роута. Для того, щоб протестити роботу кожного роута, ви можете скористатися документацією Swagger.

1. Auth

Маршрут, який відповідає за процес авторизації користувача. Його функціонал включає в себе:

  • Реєстрацію
  • Увійти в систему
  • Оновлення інформації про користувача
  • Вийти з облікового запису
  • Підтвердження електронної пошти
  • Можливість зміни пароля, якщо користувач його забув. Auth

2. Google

Шлях, призначений для авторизації користувача за допомогою електронної пошти від Google. Цей роут не відображається у Swagger, оскільки його реалізація знаходиться на фронтенді, але він доступний у фронтендовій частині додатка.

Google

3. Users

Маршрут, призначений для доступу до інформації про користувача. Тут ви можете:

  • Змінювати аватарку

  • Редагувати особисті дані

  • Отримувати інформацію про користувача

  • Вести запис про щоденний обсяг вживаної води (це стосується фронтенд-додатка Water Tracker).

    Users

4. Water

Відповідний маршрут для всіх операцій, пов'язаних з водою. Його функції включають:

  • Додавання

  • Видалення

  • Оновлення інформації про воду

  • Інформацію про щоденне та щомісячне споживання води.

    Water

Розробники

Беяр Віталій GitHub LinkedIn Карпова Софія GitHub LinkedIn Ібраімов Сервер GitHub LinkedIn
Беяр Віталій - Роут Water, Swagger Documentation Карпова Софія - Роут Auth, User, Google Ібраімов Сервер - Swagger Documentation

|

Ліцензія

Цей проєкт ліцензований під MIT Ліцензією - подробиці дивіться у файлі LICENSE. 📄

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.