Meteor Template

Overview

The Meteor template by quavequave.dev is a pre-built template project that allows users to start their Meteor projects easily. This template is designed for those who want to use React and TailwindCSS in their projects. It includes features such as sign-up and sign-in using email, router setup, basic styles, in-app alert system, and email system.

Features

• Sign-up and sign-in using email (passwordless authentication)
• Router setup
• Basic styles
• In-app alert system
• Email system

Installation

1. Install the required Npm packages for React:

   • react
   • react-dom
   • react-router-dom

   npm install react react-dom react-router-dom
   

2. Install the required Npm packages for TailwindCSS:

   • tailwindcss
   • @headlessui/react
   • @heroicons/react

   npm install tailwindcss @headlessui/react @heroicons/react
   

3. Install the required Meteor packages for React:

   • react-meteor-data

   meteor add react-meteor-data
   

4. Install the required Meteor packages for MongoDB:

   • quave:collections

   meteor add quave:collections
   

5. Install the required Meteor packages for Authentication:

   • quave:accounts-passwordless-react

   meteor add quave:accounts-passwordless-react
   

6. Install the required Meteor packages for Email:

   • quave:email-postmark

   meteor add quave:email-postmark
   

7. Install the required Meteor packages for Alerts:

   • quave:logged-user-react

   meteor add quave:logged-user-react
   

8. Set up your project by replacing the placeholders and filling the fields inside the settings in public.appInfo to ensure your app works properly.

9. Sending emails with Postmark:

   • Sign up for a Postmark account
   • Replace the following property with your Postmark API KEY in the settings: YOUR_API_TOKEN
   • Follow the steps to verify your domain on their website
   • Replace the following property with your desired ‘from’ email for the emails in the settings: YOUR_FROM_EMAIL@yourdomain.com

10. Updating your project:

    • If you want to keep your project up-to-date with the changes made here, read the CHANGELOG.
    • Changes made to the initial Meteor React skeleton include adding the Meteor packages and NPM packages listed above as dependencies, configuring eslint, configuring prettier, configuring eslint rules according to quave’s recommendations, removing npm scripts besides start, adding npm script quave-eslint, adding npm script quave-prettier, configuring husky, renaming .jsx files to .js, configuring tailwindcss, removing test folder, removing imports folder, configuring WebStorm runner to exclude unused architectures, and reorganizing App.js file to be inside app/general directory.

Summary

The Meteor template by quavequave.dev provides a convenient starting point for Meteor projects using React and TailwindCSS. It includes various features such as sign-up and sign-in functionality, router setup, basic styles, in-app alerts, and email capabilities. The installation process involves installing the necessary Npm and Meteor packages, setting up project configurations, and making adjustments for email functionality. Users can also keep their projects up-to-date by referring to the provided CHANGELOG for any changes made to the template.