Skip to content

Version 1.0.3

Latest
Latest
Compare
Choose a tag to compare
@ahadnawaz585 ahadnawaz585 released this 30 Aug 14:31
· 1 commit to main since this release
v1.0.3
7b89e9a
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

Here's a complete README.md tailored for your release version 1.0.3:

Release v1.0.3 🎉

🚀 What's New in Version 1.0.3

This release is packed with new development tools and improvements to streamline your workflow and enhance your development experience. by @ahadnawaz585 made their contribution in #4 .
Here’s what’s new:

✨ Added Development Tools for Rapid Working

  1. ESLint & Prettier Integration:

    • 📏 ESLint is now integrated to help maintain code quality and consistency.
    • 💅 Prettier is added to ensure your code is consistently formatted, making collaboration smoother.

  2. SQLite with Stable Build Support:

    • 🗄️ SQLite has been fully integrated with stable support across all builds, ensuring that your data management is robust and reliable.

  3. Vite as the New Build Tool:

    • ⚡ Vite has replaced Webpack, offering faster builds and a more modern development experience. Enjoy the benefits of instant hot module replacement (HMR) and lightning-fast startup times.

  4. Knex ORM for SQLite:

    • 🔗 Knex.js has been added as the ORM, making database migrations and querying easier and more efficient. Enjoy a seamless experience when working with SQLite.

📦 Creating Components and Pages

To create a new component, run:

npm run create:component <component-name>

Replace <component-name> with the desired name for your component. This command will:

  • Generate a new component file in src/renderer/components/.
  • Create a corresponding SCSS file for styling.

Creating Pages

To create a new page, run:

npm run create:page <page-name>

Replace <page-name> with the desired name for your page. This command will:

  • Create a new folder in src/renderer/pages/ with the page name.
  • Generate a TypeScript file and SCSS file for the page.
  • Automatically update your routing configuration to include the new page.

📚 Documentation

Please refer to the official documentation for more details on how to configure and use these new tools.

🛠️ Installation & Setup

  1. Init the Repository:

To quickly set up a new ReactronBase application, use the command-line tool:

npx create-reactronbase <app-name>

Replace <app-name> with your desired application name. This will:

  • Create a new directory with the specified name.
  • Set up the project with the necessary dependencies and configuration.

📝 Changelog

Mentioned Changes

  • Added ESLint for code linting.
  • Integrated Prettier for code formatting.
  • Replaced Webpack with Vite for faster builds.
  • Added Knex ORM for database operations.
  • Ensured SQLite stability across builds.

📦 Dependencies

  • Node.js v14+
  • npm v6+
  • SQLite for database
  • Vite as the build tool
  • Knex.js for ORM
  • ESLint for linting
  • Prettier for formatting

🤝 Contributing

We welcome contributions! Please see our contribution guidelines for more details.

📄 License

This project is licensed under the MIT License.

📫 Contact

For any issues or questions, feel free to open an issue or contact us directly.

Enjoy the new release! 🎉

Contributors

ahadnawaz585
Assets 2
Loading