Skip to content

Repository files navigation

Practical Faith Logo

Practical Faith

A modern web app for daily biblical confessions and affirmations to strengthen your faith journey.

React Version TypeScript Version Vite Version Tailwind Version

🌟 About

Daily Biblical Confessions is a beautiful web application designed to strengthen your faith through the power of God's Word. This app provides daily biblical confessions and affirmations based on God's promises, helping you speak life and truth into your daily life.

✨ Features

  • Daily Confessions: Start your day with powerful biblical affirmations
  • Personalized Experience: Get greeted by name with your daily confession
  • Emotion-Based Confessions: Find relevant scriptures based on how you're feeling
  • Category-Based Confessions: Choose from various categories like:
    • Faith & Trust
    • Healing & Health
    • Peace & Joy
    • Provision & Abundance
    • Protection & Safety
  • Share the Word: Easily share confessions via WhatsApp or copy to clipboard
  • Beautiful UI: Aesthetically pleasing design that enhances the app experience

🎨 Color Palette

Practical Faith color palette

🚀 Getting Started

Prerequisites

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

Installation

  1. Clone the repository:
git clone https://github.com/israelmitolu/Practical-Faith.git
  1. Install dependencies:
cd Practical-Faith
npm install
  1. Start the development server:
npm run dev
  1. Open your browser and visit http://localhost:8080

🤝 Contributing

We welcome and appreciate contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, your help makes Practical Faith better for everyone.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your GitHub account.

  2. Set Up Development Environment: Follow the Getting Started guide above.

  3. Create a Branch: Create a new branch for your feature or fix:

    git checkout -b feature/your-feature-name
  4. Make Your Changes: Implement your changes following our Code Style Guide.

  5. Test Your Changes: Ensure all tests pass and add new tests if needed.

  6. Submit a Pull Request: Create a PR with a clear description of your changes.

Contribution Guidelines

Please read our Contributing Guidelines and Code of Conduct before contributing. They contain important information about:

  • Code style and standards
  • Commit message format
  • Pull request process
  • Testing requirements
  • Community guidelines

Ways to Contribute

  • 🐛 Report and fix bugs
  • 📝 Improve documentation
  • 💡 Suggest new features
  • 🎨 Enhance the UI/UX
  • 🔍 Write tests
  • 🌐 Add translations
  • 📱 Improve mobile responsiveness

🛠️ Tech Stack

  • Frontend: React 18 with TypeScript
  • Styling: Tailwind CSS
  • Build Tool: Vite
  • UI Components: Shadcn UI
  • State Management: React Query
  • Routing: React Router

🗨️ Contact

For questions, suggestions, or to share testimonies about how this app has blessed you, please open an issue in the repository, or contact me on Twitter.


About

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages