sahat/hackathon-starter

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/sahat/hackathon-starter.svg?style=card)](https://bestofgithub.dev/repo/sahat/hackathon-starter)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/sahat/hackathon-starter.svg)](https://bestofgithub.dev/repo/sahat/hackathon-starter)

Loading README…

Provider	Free Tier	Website
SMTP2Go	1000 emails/month for free	https://www.smtp2go.com
Brevo	300 emails/day for free	https://www.brevo.com

Name	Description
config/cacheBust.js	Cache-busting helper for static routed files (css and front-end js)
config/flash.js	Flash middleware (replacement for express-flash)
config/morgan.js	Configuration for request logging with morgan.
config/nodemailer.js	Configuration and helper function for sending email with nodemailer.
config/passport.js	Passport Local and OAuth strategies, plus login middleware.
config/token-revocation.js	Helper for revoking OAuth tokens.
controllers/ai.js	Controller for /ai route and all ai examples and boilerplates.
controllers/ai-agent.js	Controller for /ai/ai-agent route (ReAct AI Agent boilerplate).
controllers/api.js	Controller for /api route and all api examples.
controllers/contact.js	Controller for contact form.
controllers/home.js	Controller for home page (index).
controllers/user.js	Controller for user account management.
controllers/webauthn.js	Controller for webauthn management (passkey / biometrics login)
models/User.js	Mongoose schema and model for User.
public/	Static assets (fonts, css, js, img).
public/js/application.js	Specify client-side JavaScript dependencies.
public/js/app.js	Place your client-side JavaScript here.
public/js/theme.js	Client-side dark mode toggle (localStorage persistence)
public/css/main.scss	Main stylesheet for your app.
test/*.js	Tests, related configs and helpers.
views/account/	Templates for login, password reset, signup, profile, webauthn
views/ai/	Templates for AI examples and boilerplates.
views/api/	Templates for API examples.
views/partials/flash.pug	Error, info and success flash notifications.
views/partials/header.pug	Navbar partial template.
views/partials/footer.pug	Footer partial template.
views/layout.pug	Base template.
views/home.pug	Home page template.
.env.example	Your API keys, tokens, passwords and database URI.
.gitignore	Folder and files ignored by git.
app.js	The main application file.
eslint.config.mjs	Rules for eslint linter.
package.json	NPM dependencies.
package-lock.json	Contains exact versions of NPM dependencies in package.json.

Package	Description
@fortawesome/fontawesome-free	Symbol and Icon library.
@googleapis/drive	Google Drive API integration library.
@googleapis/sheets	Google Sheets API integration library.
@huggingface/inference	Client library for Hugging Face Inference providers
@keyv/mongo	MongoDB storage adapter for Keyv
@langchain/core	Base LangChain abstractions and Expression Language
@langchain/groq	Groq chat model integration for LangChain
@langchain/langgraph	Graph-based agent orchestration used by the AI Agent example
@langchain/langgraph-checkpoint-mongodb	MongoDB-backed session/checkpoint persistence for the AI Agent
@langchain/mongodb	MongoDB integrations for LangChain
@langchain/textsplitters	LangChain text splitters for RAG pipelines
@lob/lob-typescript-sdk	Lob (USPS mailing / physical mailing service) library.
@node-rs/bcrypt	Library for hashing and salting user passwords.
@octokit/rest	GitHub API library.
@passport-js/passport-twitter	X (Twitter) login support (OAuth 2).
@popperjs/core	Frontend js library for poppers and tooltips.
@simplewebauthn/browser	WebAuthn frontend library (passkey / biometrics authentication)
@simplewebauthn/server	WebAuthn backend library (passkey / biometrics authentication)
@zapier/secret-scrubber	For redacting sensitive/secret values in objects
bootstrap	CSS Framework.
bootstrap-social	Social buttons library.
bowser	User agent parser
chart.js	Front-end js library for creating charts.
cheerio	Scrape web pages using jQuery-style syntax.
compression	Node.js compression middleware.
connect-mongo	MongoDB session store for Express.
errorhandler	Development-only error handler middleware.
express	Node.js web framework.
express-rate-limit	Rate limiting middleware for abuse protection.
express-session	Simple session middleware for Express.
jquery	Front-end JS library to interact with HTML elements.
keyv	key-value storage with support for multiple backends
langchain	Framework for developing LLM applications
lastfm	Last.fm API library.
lusca	CSRF middleware.
mailchecker	Verifies that an email address is valid and not a disposable address.
mongodb	MongoDB driver
mongoose	MongoDB ODM.
morgan	HTTP request logger middleware for node.js.
multer	Node.js middleware for handling `multipart/form-data`.
nodemailer	Node.js library for sending emails.
oauth	OAuth API library without middleware constraints.
otpauth	One-Time Password (TOTP/HOTP) library for 2FA authenticator apps.
passport	Simple and elegant authentication library for node.js.
passport-facebook	Sign-in with Facebook plugin.
passport-github2	Sign-in with GitHub plugin.
passport-google-oauth	Sign-in with Google plugin.
passport-local	Sign-in with Username and Password plugin.
passport-oauth1	Allows you to set up your own OAuth 1.0a strategy.
passport-oauth2	Allows you to set up your own OAuth 2.0 strategy.
passport-oauth2-refresh	A library to refresh OAuth 2.0 access tokens using refresh tokens.
passport-steam-openid	OpenID 2.0 Steam plugin.
patch-package	Fix broken node modules ahead of fixes by maintainers.
pdfjs-dist	PDF parser
pug	Template engine for Express.
qr	Generate and decode QR codes
sass	Sass compiler to generate CSS with superpowers.
stripe	Official Stripe API library.
twilio	Twilio API library.
twitch-passport	Sign-in with Twitch plugin.
validator	A library of string validators and sanitizers.
vanilla-cookieconsent	GDPR/CCPA-compliant cookie consent banner

Package	Description
@eslint/js	ESLint JavaScript language implementation.
@playwright/test	Automated end-to-end web testing framework (supports headless web browsers)
@prettier/plugin-pug	Prettier plugin for formatting pug templates
c8	Coverage test.
chai	BDD/TDD assertion library.
eslint-config-prettier	Make ESLint and Prettier play nice with each other.
eslint	Linter JavaScript.
eslint-plugin-chai-friendly	Makes eslint friendly towards Chai.js 'expect' and 'should' statements.
globals	ESLint global identifiers from different JavaScript environments.
husky	Git hook manager to automate tasks with git.
mocha	Test framework.
mongodb-memory-server	In memory mongodb server for testing, so tests can be ran without a DB.
nock	HTTP server mocking and expectations library for Node.js.
prettier	Code formatter.
sinon	Test spies, stubs and mocks for JavaScript.
supertest	HTTP assertion library.
lint-staged	Running tasks like formatters and linters against staged git files.

Hackathon Starter

Testimonials

Modern Theme

Flatly Bootstrap Theme

API Examples

Table of Contents

Features

Prerequisites

Getting Started

HTTPS Proxy:

ngrok

Cloudflare

Cloudflare with your own domain name

Obtaining API Keys

SMTP

Web Analytics

Google Analytics 4 Setup

Facebook Pixel

Open Graph

Project Structure

List of Packages

Useful Tools and Resources

Recommended Design Resources

Recommended Node.js Libraries

Recommended Client-side Libraries

Using AI Assistants

Providing Context to AI Tools

Example Prompts to Get You Started

FAQ

Why do I get 403 Error: Forbidden when submitting a form?

I am getting MongoDB Connection Error, how do I fix it?

I get an error when I deploy my app, why?

Why do you have all routes defined in app.js?

How It Works (mini guides)

Custom HTML and CSS Design 101

How do flash messages work in this project?

How do I create a new page?

AI Agent Controller

1. Define the agent's role

2. Replace the tools

Other Functions in ai-agent.js

Environment Variables

How do I use Socket.io with Hackathon Starter?

Cheatsheets

ES6 Cheatsheet

Declarations

Template Strings

Modules

Spread Operator

Promises

Arrow Functions

Classes

JavaScript Date Cheatsheet

Unix Timestamp (seconds)

Add 30 minutes to a Date object

Date Formatting

Next week Date object

Yesterday Date object

Mongoose Cheatsheet

Find all users:

Find a user by email:

Find 5 most recent user accounts:

Get the total count of a field from all documents:

Deployment

Hosted MongoDB Atlas

Production

Testing

Changelog

Contributing

License

Why do I get `403 Error: Forbidden` when submitting a form?