Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 3.06 KB

README.md

File metadata and controls

62 lines (36 loc) · 3.06 KB

quickstart 👋

A boilerplate with Next.js, Style-Components, TanStack Query, Josh Comeau's CSS reset, and Supabase integration. ✨

Screenshot 2023-06-10 at 02 15 32

Features ✨

📦 Built with Next.js - The React framework for production-ready applications.

💅 Styled Components - Utilize the power of CSS-in-JS with styled components to create stylish and maintainable UI components.

🔍 TanStack Query - A powerful asynchronous state management library.

🔄 Josh Comeau's CSS Reset - A solid foundation for consistent cross-browser styling.

🔧 Dotenv Config - Easily manage your environment variables with basic dotenv configuration.

🔗 Supabase Integration - Simplified configuration for Supabase, a robust open-source alternative to Firebase.

Getting Started 🚀

Follow these steps to get started with your project:

  1. Clone the repository: git clone https://github.com/your-repo.git
  2. Install dependencies: npm install or yarn install
  3. Set up your environment variables by creating a .env file. Refer to the .env.example file for guidance.
  4. Start the development server: npm run dev or yarn dev
  5. Open your browser and navigate to http://localhost:3000 to see your app in action!

Additional Information ℹ️

Supabase Integration 🔗

This boilerplate provides a basic setup for integrating Supabase into your app. Supabase is an open-source alternative to Firebase that provides a scalable and secure backend for your applications.

To use Supabase in your project, follow these steps:

  1. Open the src/utils/supabase.ts file.
  2. This file exports the Supabase client instance, which is configured to use the Supabase environment variables specified in the .env file.
  3. You can import and use this client instance in your components and modules to interact with your Supabase backend.
  4. Refer to the Supabase documentation (https://supabase.io/docs) for more details on how to use the client and perform various operations.

Contributing 🤝

Contributions are welcome! If you encounter any issues or have suggestions for improvements, please create an issue or submit a pull request. Let's make this boilerplate even better together! 🎉

License 📄

This project is licensed under the MIT License. Feel free to use it for personal or commercial projects.

Acknowledgements 🙏

Special thanks to the creators and maintainers of the technologies and libraries used in this boilerplate. Their hard work and dedication make our development process smoother and more enjoyable.