Uvuyoga

"Soar like a leaf on the wind!"

version 1.1.0 or version badge

Welcome everyone! Hello developers, qa team, app testers, yoga practitioners, and app users.

Overview

Exercise app for yoga beginners and experts. Created by a yoga instructor for yogis.

What is Uvuyoga

A specialized yoga exercise app that empowers users to add, view, and track their yoga practices. The app's future vision includes supporting yoga entrepreneurs by providing tools for managing their businesses. These features will include event scheduling, hosting online classes, and integrated payment processing to streamline their operations.

Why Contribute?

Improve a meaningful app that helps yogis worldwide. Collaborate on a NextJS tech stack, using [Material MUI] components, MongoDB, Prisma ODBC, Auth.js v5 Authentication (Google, Github, Twitter X), Google Maps API, and Google Analytics. Test written in Jest and Cypress.

Getting Started

Who Should Use This App?

• Open-source contributors.
• Yoga enthusiasts.

Sections of the App:

Asanas

• View Yoga postures details.
• Create Yoga posture.

Flows

Series are multiple asanas done in order. Series are smaller pieces that combine to make a Full Sequences.

• Practice series
• Practice sequences
• Create series, must have a user profile to enable this feature.
• Create sequences, must have a user profile to enable this feature.

Profile

• View, Edit user details.
• Profile image from social login

8 Limb Path

• Reference definitions for the 8 limbs of yoga.

How to Contribute?

Ways to Help:

• Frontend Design: Make the UI intuitive and visually appealing.
• Yoga Pose Images: Provide illustrations for various poses.
• Bug Fixes: Help identify and fix bugs.
• Testing: Write or improve Jest unit tests.
• Documentation: Enhance this ReadMe and other app docs.
• For Editing style guide use the [Bishop Fox - Cybersecurity Style Guide - v1.1] (https://www.bishopfox.com/blog/2018/02/hello-world-introducing-the-bishop-fox-cybersecurity-style-guide/)

📖 READ CONTRIBUTING.md for our code of conduct, based on this.

🤩 Open an issue for any questions or suggestions.

"Pushing good code"

Q: "Am I pushing good code?"

Answer yes to the list below and you are pushing GREAT CODE!

1. npm run dev and there aren't any errors in the server terminal or client (web browser) console.
2. npm run build no breaking build errors. Warnings are acceptable but should be minimized. Errors are not acceptable.
3. npm run cover to make sure no unit test are failing. Coverage goal is (A) 100%, (B) 90%, (C) 80%.
4. Push develop branch to hosting. Verify that the build was Successful and show Ready in vercel hosting. Then check how the app works on the web. Test with desktop and mobile device. Again checking the client (web browser) console for errors. "Click things and navigate around the app" especially any features your code touches.

Acknowledgments

• "I tip my hat to anyone whose code was used!" npm gives me a lot of people to thank!
• Special thank you to my mom, wife, and my daughters! Without their love and support this would have gone nowhere.
• Gratitude is the attitude!

Developer Guide

Prerequesites:

Node.js >=18, npm, MongoDB.

Setup Instructions:

• Clone the repository. git clone https://github.com/Trewaters/soar.git
• Install dependencies: npm install
• Set up a local MongoDB instance or use MongoDB Atlas.
• Start the development server and local DB instance: npm run concurrent

Dev tip: sometimes I need to clear my npm cache so the library versions are installed correctly.

npm cache clean --force

MongoDB instructions

Install MongoD locally for development purposes. Use Cloud services for production.

install location:

"C:\Program Files\MongoDB\Server\7.0\bin\mongod.exe" --dbpath="c:\data\db"

mongod --version

Start MongoDB locally

1. Start app: npm run dev
2. Run with replica set in config: mongod --config C:/data/config/mongod.conf

mongod.conf

Example details for my current config file.

# mongod.conf

# Where and how to store data.
storage:
  dbPath: c:/data/db

# where to write logging data.
systemLog:
  destination: file
  path: C:/data/log/mongod.log

# network interfaces
net:
  port: 27017
  bindIp: 127.0.0.1  # Listen to local interface only, comment to listen on all interfaces.

# processManagement options
processManagement:
  pidFilePath: C:/data/mongod.pid  # location of pidfile

# Replica Set Config
replication:
  replSetName: "rs0"

Backup DB

MongoDump creates files that can be used to restore database with Mongorestore.

mongodump --uri="mongodb://localhost:27017" --out=C:/data/mongoDumpLocalhost

mongodump --uri="mongodb+srv://<USERNAME>:<PASSWORD>@<YOUR.DETAILS.mongodb.net>/yogadb?replicaSet=<REPLICA_SET_ID>&retryWrites=true&w=majority" --out=C:/data/mongoDumpProduction

Restore DB

MongoRestore restores files created by mongoDump to a MongoDB instance. This command resotres from a directory to the local mongod instance.

mongorestore  C:/data/mongoDump/

Export collection

mongoexport --collection=<coll> <options> <connection-string> --jsonArray

mongoexport --collection=AsanaPosture mongodb://localhost:27017/yogaDBSandbox

mongoexport --collection=AsanaPosture mongodb://localhost:27017/yogaDBSandbox --out=C:/data/export/exported_AsanaPosture.json

mongoexport --collection=AsanaSequence mongodb://localhost:27017/yogaDBSandbox --out=C:/data/export/exported_AsanaSequence.json

mongoexport --collection=AsanaSeries mongodb://localhost:27017/yogaDBSandbox --out=C:/data/export/exported_AsanaSeries.json

mongoexport --collection=ProviderAccount mongodb://localhost:27017/yogaDBSandbox --out=C:/data/export/exported_ProviderAccount.json

mongoexport --collection=UserData mongodb://localhost:27017/yogaDBSandbox --out=C:/data/export/exported_UserData.json

mongoexport --collection=accounts mongodb://localhost:27017/yogaDBSandbox --out=C:/data/export/exported_accounts.json

mongoexport --collection=users mongodb://localhost:27017/yogaDBSandbox --out=C:/data/export/exported_users.json

Tests

Jest unit test

• Jest for unit tests. Run: npm run test.
• End-to-end tests (WIP).

My current excuse is to wait until MVP before creating test around features.

Running unit tests

execute the unit tests via Jest Jest.

Running end-to-end tests

execute the end-to-end tests via ?Test Kit Protractor.

Originally Found yoga poses here. Currently used for test data. Final version of the application will have user generated data for postures.

Visual/UI Style Guide

View the style guide page to see fonts, colors, and letter sizing across the website. Includes some buttons and common components.

dev Style Guide prod Style Guide

Coding Style Guide

1. Prettier
2. Eslint

Deployment

Deployed on Vercel

An easy way to deploy your Next.js app is with Vercel.

Check out our Next.js deployment documentation for more details.

Changelog

Types of changes

• ADD: for new features.
• UPDATE: for changes in existing functionality.
• DEPRECATE: for soon-to-be removed features.
• REMOVE: for now removed features.
• FIX: for any bug fixes.
• SECURITY: in case of vulnerabilities.
• AUDIT: code clean up. Carefully removing unnecessary files.

Prisma Database

Start using Prisma Client in Node.js (See: https://pris.ly/d/client)

import { PrismaClient } from './prisma/generated/client'
const prisma = new PrismaClient()

or start using Prisma Client at the edge (See: https://pris.ly/d/accelerate)

import { PrismaClient } from './prisma/generated/client/edge'
const prisma = new PrismaClient()

npx prisma generate

npm exec prisma db push

This is failing for mongodb at the moment (2024-08-09 06:22:38)

npm exec prisma migrate dev

Authors

• Tre' Grisby - Initial work - trewaters

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE.md file for details.

Known Bugs

TITLE (as of DATE)

Twitter Auth Forbidden (as of 2024-07-26 16:18:25)

Currently setup to use v5 of Auth.js. Provider must be tested from Vercel hosting due to TwitterX terms of use. When trying to login through provider I get a 403 error in the browser. No errors showing in Vercel. Just has redirect log to Twitter auth.

Jul 26 16:13:09.71
POST
302
soar-pqzo6upmv-trewaters-projects.vercel.app
/auth/signin/twitter

What you are experiencing is a feature 😉 ! Open a github issue if you disagree.

Branching Strategy

1. main: production ready, mostly stable branch. Used for production deployment (publised to Vercel).
2. develop: active development, active work that is merged into main. Use this branch to check builds and pre-production deployment issues. Any work I started is a branch created from develop.
3. version_stable - stable version this is the stable build of the most current version I am working on.
4. Feature branches: feature/<feature-name> - features I work on that could go merge into develop when complete. version_010 - release version 0.1.0.

Current internal "feature" branches

I create branches with the name of the feature I plan to work on. This way I keep my work seperated. If I don't finish I can come back to it, but it won't interfere with any other work I want to do on the app. These have been created organically and are due to change without notice because I am currently working alone.

• "feature/app-theme-and-style": Update the app theme and style. Use professional themes as influence. Link to "Style Guide" page
• "feature/flow": Flow portions of the app. Views (Practice view), edit, create Asanas, Series and Sequences.
• "feature/auth": Develop authentication, user roles, general app security, etc.
• "feature/nav": Application navigation elements
• "feature/profile": Work on the yogi user profile. Allow view, edit and shareable link of profile data.
• "feature/posture-cards": Work on asana features. Allow view, edit, and create postures.
• "feature/core": Core work in the app like data connections, env variables, etc.

The "version" branches are locked after release.

I follow Semantic Versioning for releases. Read more here ...TLDR: "A normal version number MUST take the form X.Y.Z where X, Y, and Z are non-negative integers, and MUST NOT contain leading zeroes. X is the major version, Y is the minor version, and Z is the patch version. Each element MUST increase numerically. For instance: 1.9.0 -> 1.10.0 -> 1.11.0.