Astro - Barbajs Starter Theme

Welcome to the Astro - Barbajs Starter theme! This open-source starter kit is designed for developers looking to create dynamic websites with complex page transitions using the Astro framework. Leverage the power of Astro, Tailwind CSS, TypeScript, GSAP, and Barba.js to build visually stunning and engaging web experiences.

Key Features

• Astro Framework: Utilize the fast and flexible Astro framework to build static and dynamic web applications.
• Tailwind CSS: Rapidly design responsive layouts with a utility-first CSS framework.
• TypeScript: Enhance your development workflow with a statically typed language for improved code quality and maintainability.
• GSAP: Create captivating animations with the industry-standard JavaScript animation library.
• Barba.js: Implement complex page transitions effortlessly to create a seamless user experience.
• Sanity CMS Integration: Manage and update your content with ease using a headless CMS that supports real-time collaboration.
• Overlay Transitions: Enhance user interaction with smooth and engaging overlay transitions.

Screenshots

screenshots coming soon!

Getting Started

Follow these steps to get started with the Astro - Barbajs Starter theme:

1. Clone the repository:

   git clone https://github.com/judahsullivan/AstroBlogV4-Barbajs.git
   cd AstroBlogV4-Barbajs

2. Install dependencies:

   npm install

3. Run the development server:

   npm run dev

4. Build for production:

   npm run build

5. Preview the production build:

   npm run preview

6. Add your Enviornment Variables

• go to your Sanity Project and enter the ProjectId and Dataset(which is usually "production") inside the .env.example
• remove the .example from the file head to your studio route "localhost:4321/studio"

Contributing

We welcome contributions from the community! Please refer to our Contributing Guide for guidelines on how to get involved.

License

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

Contact

If you have any questions or need support, feel free to open an issue on the GitHub repository.

Thank you for your interest in the Astro - Barbajs Starter theme! We look forward to seeing what you create with it.

Contributing to Astro - Barbajs Starter Theme

Thank you for considering contributing to the Astro - Barbajs Starter theme! We appreciate your interest in improving this project and welcome contributions from the community.

How to Contribute

1. Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue in the GitHub Issues section. Provide as much detail as possible to help us understand and resolve the issue.

2. Submitting Pull Requests

To submit a pull request, follow these steps:

1. Fork the repository on GitHub.

2. Clone your fork to your local machine:

   
   git clone https://github.com/your-username/AstroBlogV4-Barbajs.git

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

   git checkout -b feature/your-feature-name

4. Make your changes in your local repository.

5. Commit your changes with a descriptive commit message:

   git commit -m "Add your descriptive commit message here"

6. Push your changes to your fork:

   git push origin feature/your-feature-name

7. Create a pull request on the original repository by navigating to the "Pull Requests" tab and clicking "New Pull Request."

3. Code of Conduct

We ask that all contributors adhere to our Code of Conduct to ensure a positive and inclusive community.

Development Guidelines

• Code Style: Follow the existing code style in the project. Use Prettier and ESLint to ensure consistency.
• Testing: Ensure that any new features or bug fixes include appropriate test coverage.
• Documentation: Update documentation and comments to reflect your changes.

Contact

For questions or support related to contributing, please reach out via the GitHub Discussions.

Thank you for contributing!