{"id":13472336,"url":"https://github.com/MLH/mlh-hackathon-nodejs-starter","last_synced_at":"2025-03-26T15:31:56.669Z","repository":{"id":34388671,"uuid":"172533492","full_name":"MLH/mlh-hackathon-nodejs-starter","owner":"MLH","description":"Hackathon starter project for Node.js applications","archived":true,"fork":false,"pushed_at":"2022-02-11T04:09:06.000Z","size":263,"stargazers_count":698,"open_issues_count":23,"forks_count":214,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-10-30T04:13:40.821Z","etag":null,"topics":["hackathon-starter","hackathons","nodejs"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MLH.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-25T15:37:02.000Z","updated_at":"2024-10-28T12:17:03.000Z","dependencies_parsed_at":"2022-08-08T01:00:20.453Z","dependency_job_id":null,"html_url":"https://github.com/MLH/mlh-hackathon-nodejs-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MLH%2Fmlh-hackathon-nodejs-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MLH%2Fmlh-hackathon-nodejs-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MLH%2Fmlh-hackathon-nodejs-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MLH%2Fmlh-hackathon-nodejs-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MLH","download_url":"https://codeload.github.com/MLH/mlh-hackathon-nodejs-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245681421,"owners_count":20655189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hackathon-starter","hackathons","nodejs"],"created_at":"2024-07-31T16:00:53.874Z","updated_at":"2025-03-26T15:31:56.335Z","avatar_url":"https://github.com/MLH.png","language":"HTML","readme":"# Introduction\n\nThis is a hackathon boilerplate for new Node.js applications created by [Major League Hacking](https://github.com/mlh). It is for hackers looking to get started quickly on a new hackathon project using the Node.js environment.\n\n- [Installation Guide](#installation-guide) - How to get started with a new Node.js app\n- [User Guide](https://github.com/MLH/mlh-hackathon-nodejs-starter/blob/master/docs/USER_GUIDE.md) - How to develop apps created with this starter project\n- [Contributing Guide](https://github.com/MLH/mlh-hackathon-nodejs-starter/blob/master/docs/CONTRIBUTING.md) - How to contribute to the project\n\n# \u003ca name='installation-guide'\u003eInstallation Guide\u003c/a\u003e\n\nThis project requires the following tools:\n\n- [Node.js](https://nodejs.org/en/) - The JavaScript environment for server-side code.\n- [NPM](https://www.npmjs.com/) - A Node.js package manager used to install dependencies.\n- [PostgreSQL](https://www.postgresql.org/) - A relational database system.\n\nTo get started, install NPM and Postgres on your local computer if you don't have them already. A simple way for Mac OS X users to install Postgres is using [Postgres.app](https://postgresapp.com/). Here is a [Windows guide](https://www.postgresqltutorial.com/install-postgresql/) for installing PostgresSQL.\n\n## Getting Started\n\n**Step 1. Clone the code into a fresh folder**\n\n```\n$ git clone https://github.com/MLH/mlh-hackathon-nodejs-starter.git\n$ cd mlh-hackathon-nodejs-starter\n```\n\n**Step 2. Install Dependencies.**\n\nNext, we need to install the project dependencies, which are listed in `package.json`.\n\n```\n$ npm install\n```\n\n**Step 3: Create an app on GitHub**\n\nHead over to [GitHub OAuth apps](https://github.com/settings/developers) and create a new OAuth app. Name it what you like but you'll need to specify a callback URL, which should be something like:\n\n```\nhttps://localhost:5000/auth/callback/github\n```\n\nThe default port for our app is `5000`, but you may need to update this if your setup uses a different port or if you're hosting your app somewhere besides your local machine.\n\n**Step 4: Update environment variables and run the Server.**\n\nCreate a new file named `.env` by duplicating `.env.sample`. Update the new file with the GitHub credentials. It should look similar to this:\n\n```\n# .env file\nDATABASE_URL=\"[INSERT_DATABASE_URL]\"\nGITHUB_CLIENT_ID=\"[INSERT_CLIENT_ID]\"\nGITHUB_CLIENT_SECRET=\"[INSERT_CLIENT_SECRET]\"\n```\n\nYou replace the GitHub credentials here and update the database URL. Learn more about the required [Environment Variables here](#environment-variables).\n\nNow we're ready to start our server which is as simple as:\n\n```\n$ npm start\n```\n\nOpen http://localhost:5000 to view it in your browser.\n\nThe app will automatically reload if you make changes to the code.\nYou will see the build errors and warnings in the console.\n\n# What's Included?\n\n- [Express](https://expressjs.com/) - A minimal web framework for Node.js web applications\n- [Sequelize](http://docs.sequelizejs.com/) - A promise-based ORM for Node.js that supports PostgreSQL, MySQL, and SQLite.\n- [Bootstrap 4](https://getbootstrap.com/) - An open source design system for HTML, CSS, and JS.\n- [Handlebars](https://handlebarsjs.com/) - A popular templating language for building layouts.\n\n# Code of Conduct\n\nWe enforce a Code of Conduct for all maintainers and contributors of this Guide. Read more in [CONDUCT.md][mlh-conduct].\n\n# License\n\nThe Hackathon Starter Kit is open source software [licensed as MIT][mlh-license].\n\n[mlh-conduct]: https://github.com/MLH/mlh-hackathon-nodejs-starter/blob/master/docs/CONDUCT.md\n[mlh-license]: https://github.com/MLH/mlh-hackathon-nodejs-starter/blob/master/LICENSE.md\n","funding_links":[],"categories":["HTML"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMLH%2Fmlh-hackathon-nodejs-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMLH%2Fmlh-hackathon-nodejs-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMLH%2Fmlh-hackathon-nodejs-starter/lists"}