Skip to content

A modern web application for creating beautifully styled, shareable images of scripture verses. Search for any Bible verse, customize its appearance, and export it for social media, presentations, or personal inspiration.

Notifications You must be signed in to change notification settings

Chandu4143/scripture-share

Repository files navigation

Scripture Share Style

A modern web application for creating beautifully styled, shareable images of scripture verses. Search for any Bible verse, customize its appearance, and export it for social media, presentations, or personal inspiration.

✨ Features

  • Verse Search: Quickly find any scripture using an intuitive search interface.
  • Style Customization: A comprehensive set of tools to adjust fonts, colors, backgrounds, and layout.
  • Live Preview: See your changes in real-time as you create your perfect design.
  • Image Export: Download your creation as a high-quality image, ready to be shared.
  • History: Keep track of your previously designed verses for easy access.

🛠️ Tech Stack

This project is built with a modern, robust technology stack:

  • Framework: React with Vite for a fast development experience.
  • Language: TypeScript for type safety and improved code quality.
  • UI Components: Shadcn/UI for a set of beautifully designed, accessible components.
  • Styling: Tailwind CSS for a utility-first CSS framework.
  • Routing: React Router for client-side navigation.
  • State Management: TanStack Query for managing server state and caching.
  • Form Handling: React Hook Form for efficient and flexible form validation.

🚀 Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have Node.js (version 18 or higher) and npm installed on your machine.

Installation

  1. Clone the repository:
    git clone https://github.com/Chandu4143/scripture-share-style.git
  2. Navigate to the project directory:
    cd scripture-share-style
  3. Install NPM packages:
    npm install

Running the Application

Start the development server to view the application in your browser:

npm run dev

The application will be available at http://127.0.0.1:5173 (or the next available port).

📦 Available Scripts

In the project directory, you can run:

  • npm run dev: Runs the app in development mode.
  • npm run build: Builds the app for production to the dist folder.
  • npm run lint: Lints the project files using ESLint.
  • npm run preview: Serves the production build locally for preview.

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.

About

A modern web application for creating beautifully styled, shareable images of scripture verses. Search for any Bible verse, customize its appearance, and export it for social media, presentations, or personal inspiration.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages