Skip to content

Repository files navigation

InternPing Documentation

English product and technical documentation for the Intern Calendar application in Microsoft_Intern_Project. The documented application is a React and Express Microsoft Teams tab with SQLite persistence, Entra authentication, role-aware event approvals, Outlook SQL import, and manual ICS export.

This site is built with Docusaurus 3 and deployed to GitHub Pages. It documents the application but does not contain the application runtime itself.

Local development

npm ci
npm start

The development server opens at http://localhost:3000 and reloads when source files change.

Validation

npm run typecheck
npm run build
npm run serve

The production site is generated in build/. npm run serve previews that output locally.

GitHub Pages deployment

The workflow in .github/workflows/deploy-pages.yml builds and deploys every push to main. It derives the owner and project path from the GitHub repository, so no account placeholders are stored in configuration.

  1. Push this project to a GitHub repository whose default branch is main.
  2. Open Settings > Pages in the repository.
  3. Under Build and deployment, select GitHub Actions as the source.
  4. Push to main or run Deploy documentation to GitHub Pages from the Actions tab.

The published URL is https://<owner>.github.io/<repository>/. The workflow sets SITE_URL and BASE_URL automatically for this project-site format.

For a user or organization site whose repository is named <owner>.github.io, change the workflow's BASE_URL to /.

Content map

  • / - Product overview
  • /docs/features - Implemented calendar, workflow, import, and export capabilities
  • /docs/architecture - React, Express, Entra, SQLite, API, and data flows
  • /docs/installation - Local runtime, configuration, and Teams deployment
  • /docs/user-guide - Intern, member, and administrator workflows

About

To gain access, please finish setting up this repository now at:

Resources

Code of conduct

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages