Skip to content
Get packs

Guide · Open source

How to use hackathon-starter: install, run and extend it

Updated · written with AI from the project's own documentation and checked against our catalogue data

Hackathon Starter is an MIT-licensed boilerplate for Node.js web applications. It gives you a working app with local login, OAuth 2.0 sign-in and account management so you can skip the setup and focus on your project. This guide shows you how to install it, run it, and start adapting it.

Hackathon Startersahat/hackathon-starter · ★ 35.3k · MIT

Quick start

  1. 1Check prerequisites. Install Node.js LTS 24, set up MongoDB locally or with a hosted service, and install the command line build tools for your OS.
  2. 2Clone the repository. Run git clone with the repository URL and name the folder myproject.
  3. 3Change directory. Run cd myproject to move into the project folder.
  4. 4Install dependencies. Run npm install to download the NPM packages the project needs.
  5. 5Start the app. Run npm start, then open the app in your web browser.
  6. 6Add your API keys. Set real keys as environment variables for the features you want to use, and keep placeholders for the rest.

What does hackathon-starter include?

The project is a pre-built Node.js web application that you copy and extend. Its stated goal is simplicity and ease of use, covering common hackathon needs without being too specific.

Login features include local authentication with email and password, plus OAuth 2.0 sign-in with providers such as Google, Microsoft, Facebook, GitHub and Discord. Account features include profile details, password management, email verification, and two-factor authentication.

  • Local authentication: email and password, passwordless, passkey / biometrics
  • OAuth 2.0 sign-in: Google, Microsoft, Facebook, LinkedIn, X (Twitter), Twitch, GitHub, Discord
  • Account management: profile, password change/reset, email verification, 2FA, account deletion
  • Other features: contact form, file upload, device camera, dark mode toggle, CSRF protection, MVC project structure

What do you need before you install it?

You need Node.js LTS 24, MongoDB (either a local install or a hosted instance), and command line build tools for your operating system. The README notes that you do not need to install MongoDB locally if you use a hosted option such as MongoDB Atlas.

If you are new to Node or Express, the README points to beginner tutorials on Node.js, Express and MongoDB before you start.

  • Node.js LTS 24
  • MongoDB: local install or hosted
  • Command line tools: Xcode tools on macOS, build-essential on Ubuntu/Linux Mint, Development Tools on Fedora, devel_basis on OpenSUSE, or Visual Studio / WSL on Windows

How do you install and start hackathon-starter?

Clone the repository into a folder named myproject, change into it, install the NPM dependencies, then start the app. The README presents this as the easiest way to get started.

git clone https://github.com/sahat/hackathon-starter.git myproject cd myproject npm install npm start

How do you add API keys and configure the app?

After the app runs and MongoDB is installed, you can use the local user accounts in a browser. Features that call third-party APIs may not work until you get real keys from each provider. The keys in the project are placeholders, so you can keep them for features you are not using.

The README suggests setting keys as environment variables rather than putting them in code, because this reduces the risk of committing secrets. For example, in bash you can run export with the variable name and value.

  • Keep placeholder keys for features you do not use yet
  • Set real keys as environment variables instead of editing source files
  • Nodemon is recommended to restart the server automatically when you change code
export FACEBOOK_SECRET=xxxxxx

How can you use it as a learning reference?

You do not have to use the whole boilerplate. The author notes that it can serve as a learning guide if you only need one feature, such as Sign in with Google.

The features include example API integrations such as Stripe, Twilio, Google Maps and GIPHY, which you can read and adapt to your own project.

  • Read the Google sign-in code as a reference for OAuth 2.0
  • Study the MVC structure to see how routes, views and models fit together
  • Adapt an existing API example rather than writing the integration from scratch

What should you check before you build on it?

The README includes a Go to production checklist, and sections on HTTPS proxy support, web analytics and deployment. Review these before you put a project online.

Treat the project as a starting point. It ships with placeholder API keys and example integrations that you need to adapt to your own needs.

  • Read the Production and Deployment sections of the README
  • Replace all placeholder keys with your own before going live
  • Use the HTTPS proxy option (such as ngrok or Cloudflare) when you need a secure tunnel during development

What people use it for

  • Build a hackathon project that needs sign-in with Google or another OAuth provider from the start
  • Learn how Node.js, OAuth 2.0 and MongoDB work together by reading a working app
  • Use the Stripe, Twilio or Google Maps examples as a starting point for your own integration
  • Start an MVC-structured Node.js project with user accounts already in place

Frequently asked questions

Is hackathon-starter free to use?

Yes. The project is released under the MIT licence, as stated in the project summary. Check the LICENSE file in the repository for the full terms.

What do I need to install hackathon-starter?

You need Node.js LTS 24, MongoDB (local or hosted), and command line build tools for your operating system. The README lists specific tool installs for macOS, Windows, Ubuntu, Fedora and OpenSUSE.

How do I install hackathon-starter?

Clone the repository with git clone https://github.com/sahat/hackathon-starter.git myproject, then run cd myproject, npm install and npm start.

Do I need to know MongoDB to use it?

Yes, the project uses MongoDB. You can install it locally or use a hosted option. The README says beginners with no Node or MongoDB experience may want to learn those basics first.

Why don't the API integrations work after I install it?

The API keys in the project are placeholders. You need to obtain keys from each service provider and set them, usually as environment variables, before those features will work.

What is hackathon-starter not suitable for?

It is not suitable if you need a non-Node.js stack, since it is built on Node.js and JavaScript. It is also not a finished product, so expect to adapt it to your project.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Hackathon Starter suits developers and students who are building a Node.js project and want login, OAuth 2.0 and an MVC structure already in place. It is less suitable if you need a non-JavaScript stack, have no Node or MongoDB experience, or want a finished product rather than a starting point.

Install options & downloads