Active Handout

Setup

Install pnpm and run from the root folder:

pnpm install

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   └── Card.astro
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
`npm install`	Installs dependencies
`npm run dev`	Starts local dev server at `localhost:3000`
`npm run build`	Build your production site to `./dist/`
`npm run preview`	Preview your build locally, before deploying
`npm run astro ...`	Run CLI commands like `astro add`, `astro check`
`npm run astro -- --help`	Get help using the Astro CLI

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.

Showing Toast notifications

You can show a toast notification by dispatching an event "NotifyToast" to document. You can use the function @insperedu/active-handout/components/notifier/custom-events.ts:

dispatchNotification("YOUR MESSAGE HERE");

Running for the first time with .auth enabled

You will need to setup a Firebase account and create a Realtime Database and a Storage within it. Then, copy the file .env.example to .env in your project's root folder.

After creating your Storage you will need to change the permission rules. Go to the Rules tab in the Firestore dashboard and change the content to:

rules_version = '2';

// Craft rules based on data in your Firestore database
// allow write: if firestore.get(
//    /databases/(default)/documents/users/$(request.auth.uid)).data.isAdmin;
service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read;
    }
  }
}

Publishing on npm

Run

pnpm version patch
pnpm publish --access public

toshikurauchi/active-handout-astro