https://github.com/victot0121/meditation-app
Serenity is a mobile meditation app designed to help users achieve relaxation and mindfulness through guided meditation sessions and ambient sounds. Built with React Native and leveraging the power of Expo and various libraries, Serenity offers a seamless and immersive meditation experience for both iOS and Android users.
https://github.com/victot0121/meditation-app
expo expo-av expo-linear-gradient expo-linking expo-router expo-system-ui react-native react-native-reanimated tailwindcss typescript
Last synced: 3 months ago
JSON representation
Serenity is a mobile meditation app designed to help users achieve relaxation and mindfulness through guided meditation sessions and ambient sounds. Built with React Native and leveraging the power of Expo and various libraries, Serenity offers a seamless and immersive meditation experience for both iOS and Android users.
- Host: GitHub
- URL: https://github.com/victot0121/meditation-app
- Owner: victot0121
- Created: 2024-07-26T05:39:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T15:10:02.000Z (almost 2 years ago)
- Last Synced: 2025-01-22T19:36:13.005Z (over 1 year ago)
- Topics: expo, expo-av, expo-linear-gradient, expo-linking, expo-router, expo-system-ui, react-native, react-native-reanimated, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 45.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serenity πΏ
**Serenity** is a cross-platform meditation app designed to help users relax, focus, and improve mindfulness through guided meditation sessions and ambient sounds.
Built with **React Native**, powered by **Expo**, and styled using **Tailwind CSS** via NativeWind, Serenity provides a smooth and immersive experience on both Android and iOS platforms.
---
## π± Features
- π§ββοΈ Guided meditation sessions
- πΆ Soothing ambient sounds
- π¨ Beautiful gradients & visuals
- β‘ Fast and responsive UI
- π Dark mode friendly
- π Seamless navigation with `expo-router`
---
## π Tech Stack
- [React Native](https://reactnative.dev/)
- [Expo](https://expo.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- [Tailwind CSS (NativeWind)](https://www.nativewind.dev/)
- [React Native Reanimated](https://docs.swmansion.com/react-native-reanimated/)
- [expo-av](https://docs.expo.dev/versions/latest/sdk/av/)
- [expo-linear-gradient](https://docs.expo.dev/versions/latest/sdk/linear-gradient/)
- [expo-router](https://expo.github.io/router/)
---
## π¦ Installation
Make sure you have **Node.js**, **npm**, **Expo CLI**, and **EAS CLI** installed:
```bash
npm install -g expo-cli eas-cli
````
Then clone the project and install dependencies:
```bash
git clone https://github.com/yourusername/serenity-app.git
cd serenity-app
npm install
```
---
## π§ͺ Running the App Locally
### Start in development mode:
```bash
npm start
```
Or run on Android/iOS simulator:
```bash
npm run android
npm run ios
```
---
## π¨ EAS Build (APK or iOS)
First, log in to EAS:
```bash
eas login
```
Then configure the build setup (if not already done):
```bash
eas build:configure
```
To build for **Android (APK)** locally:
```bash
eas build --platform android --profile preview --local
```
Or to build on Expoβs cloud:
```bash
eas build --platform android
```
> π See [EAS Build Documentation](https://docs.expo.dev/build-reference/eas-json/) for more.
---
## π Project Structure
```
meditation-app/
βββ app/ # Expo Router app folder
βββ assets/ # Images, fonts, audio files
βββ components/ # Reusable UI components
βββ scripts/ # Dev helper scripts
βββ tailwind.config.js # Tailwind setup
βββ eas.json # EAS Build config
βββ app.json # Expo config
βββ ...
```
---
## π§Ό Useful Scripts
* `npm run lint` β Lint your code
* `npm run test` β Run tests
* `npm run reset-project` β Clean and reset cache (custom script)
---
## β
Dependencies
See the full list in `package.json`, including:
* `expo`: `~51.0.22`
* `react-native`: `0.74.3`
* `expo-av`, `expo-linear-gradient`, `expo-router`, `react-native-reanimated`, and more.
---
## π§ License
MIT License Β© 2025 \[Your Name]
---
## π€ Contributing
Pull requests and feedback are welcome! Letβs build a more mindful world together.
---
## πΈ Screenshots
> *(Add screenshots of the home page, meditation player, and other screens here if available.)*
---
## π Links
* [Expo Docs](https://docs.expo.dev/)
* [EAS Build Guide](https://docs.expo.dev/build/introduction/)
* [Tailwind for React Native (NativeWind)](https://www.nativewind.dev/)
```
---
Would you like a sample `eas.json` configuration to go with this as well?
```