Serene

Serene is a mindfulness and meditation web application designed to help users embark on a journey of self-discovery and relaxation. The app provides tools and resources for meditation, a 21-day guided journey, and other wellness features.

Features

• Home Page: A welcoming landing page introducing the app.
• Meditation Tools: Guided meditations and timers to help users focus and relax.
• 21-Day Journey: A structured program to guide users through a transformative mindfulness experience.
• Responsive Design: Optimized for both desktop and mobile devices.

Tech Stack

• Frontend: React, TypeScript, TailwindCSS
• State Management: React Query
• Routing: React Router
• Backend Integration: Supabase for authentication and database management
• Build Tool: Vite

Folder Structure

• src/: Contains all the source code for the application.
  • components/: Reusable UI components.
  • pages/: Individual pages of the application.
  • hooks/: Custom React hooks.
  • integrations/: Integration with external services like Supabase.
  • lib/: Utility functions.
• public/: Static assets like robots.txt.

Getting Started

Prerequisites

• Node.js (v16 or higher)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/arj-co/serene
   cd serene

2. Install dependencies:

   npm install

3. Set up environment variables:

   • Create a .env file in the root directory.
   • Add your Supabase credentials and other required environment variables.

4. Start the development server:

   npm run dev

5. Open the app in your browser:

   http://localhost:3000
   

Scripts

• npm run dev: Start the development server.
• npm run build: Build the app for production.
• npm run preview: Preview the production build locally.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

• Built with ❤️ using React, TailwindCSS, and Supabase.
• Inspired by the need for mindfulness and wellness in daily life.