https://github.com/roodbaraky/nafasapp

A Mobile-first Progressive Web App (PWA) built with TypeScript, React + Vite, PostgreSQL for Tummo-inspired breathwork practice.
https://github.com/roodbaraky/nafasapp

framer framer-motion postgresql pwa pwa-apps react supabase typescript vite

Last synced: 23 days ago
JSON representation

A Mobile-first Progressive Web App (PWA) built with TypeScript, React + Vite, PostgreSQL for Tummo-inspired breathwork practice.

• Host: GitHub
• URL: https://github.com/roodbaraky/nafasapp
• Owner: Roodbaraky
• License: mit
• Created: 2024-06-27T16:28:27.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-07-04T21:03:02.000Z (7 months ago)
• Last Synced: 2024-11-19T04:08:01.626Z (3 months ago)
• Topics: framer, framer-motion, postgresql, pwa, pwa-apps, react, supabase, typescript, vite
• Language: TypeScript
• Homepage:
• Size: 224 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nafas

Nafas (نَفَس), meaning 'breath', is a progressive web app (PWA) for guided breathwork practice. Try it here: ```nafas.websiteplaceholder.com```

It is designed to be run and installed on any PWA capable device, with an emphasis on mobile and offline use. 

The aim of Nafas is to provide users with an accessible and versatile guided breathwork experience, focusing primaliry on tummo-inspired breathwork, but expanding to include other variations in later iterations.

Nafas adheres to principles of digital minimalism, throttling features to what is pragmatic and provides value. In this vein, the project should remain viable as an offline application for all core functions, only requiring online capability to sync user data. 

### Built using:

- [![React][React.js]]

- [![Vite][Vite.js]]

## How to use:

- Navigate to ```nafas.websiteplaceholder.com```

- From here you can either use Nafas on the web or **install it on your device**

- Find a comfortable position to practice and press 'Start'

- Enjoy the benefits of breathwork!

## Running the project from source:

### Requirements:

- Node.js v.20.14 +

- Npm v.10.7 +

## Download:

Download this repo via zip or clone using git.

- ```git clone https://github.com/roodbaraky/nafasApp.git```

## Install dependencies:

- ```cd nafas```

- ```npm install`

## Development server:

- ```npm run dev``

[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB

[Vite.js]: https://img.shields.io/badge/Vite-20232A?style=for-the-badge&logo=vite&logoColor=61DAFB