Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 3.38 KB

README.md

File metadata and controls

56 lines (42 loc) · 3.38 KB
Raw

Stein Banner

NPM Version NPM Downloads GitHub License

Stein is a framework for SolidJS built on top of Vite to provide helpers and tools to make your life easier while developing SPAs. It is modular with a plugin system based on Vite plugins and a CLI to make it easy to get started.

⬇️ Install

The recommended way to get started using Stein is by running the command below:

npm create stein@latest

The process should look something like this:

stein_cli

For more detailed instructions, please reference our Getting Started guide.

⁉️ Why Stein?

We aim to create a framework that simplifies the initial project setup and provides a rich experience for a SolidJS SPA. Our core philosophy is "do one thing and do it well", and in this case we just want an experience which is close to building a SPA using just Vite, but with some extra bells and whistles to improve developer experience. We are not trying to compete with the current offerings in the ecosystem but rather provide an alternative with some opiniated defaults provided by us.

Features:

  • A solid foundation for your SolidJS SPA
  • Improved project scaffolding and setup using the Stein CLI
  • Modular plugin system with plug and play experience (inspired by Nuxt)
  • Zero-config integrations with popular libraries like Tailwind and UnoCSS (more coming soon)
  • More coming soon (help us out!)

🛠️ Contributing

We welcome contributions to Stein. If you're interested in contributing, please read our contributing guide and reach out through GitHub (issues, discussions) or on Discord to ask about something you'd like to work on.

Here's some ways you can help us:

  • Help us test the framework: At the moment, we are just two developers working on the project. Any help in testing the framework and making sure it works well is appreciated to help us iron out any initial issues.
  • Write documentation: The documentation is still a work in progress and we would love your help to make it better.
  • Provide feedback and suggestions: We're always looking for feedback on how we can improve the framework. If you have any suggestions, please let us know!

👥 Community

If you want to get in touch with the community and stay up to date, feel free to join our Discord server. This is where you can chat with us, get some insights into the current state of development and ask any questions.

Contributors

📜 License

We love open source and are grateful for any support we receive from the community. Stein is free and open source and licensed under the MIT license.

Copyright © 2024 Stein contributors