{"id":22820072,"url":"https://github.com/ridays2001/ht-site","last_synced_at":"2025-12-30T20:28:53.088Z","repository":{"id":186368982,"uuid":"275311728","full_name":"ridays2001/ht-site","owner":"ridays2001","description":"A student portal site for home tutorials business.","archived":false,"fork":false,"pushed_at":"2021-07-07T11:26:57.000Z","size":1702,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-08-05T18:27:07.856Z","etag":null,"topics":["bootstrap","expressjs","javascript","nodejs","portal","pug","student-information-system"],"latest_commit_sha":null,"homepage":"https://ht-site.herokuapp.com/","language":"Pug","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/ridays2001.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-06-27T06:14:34.000Z","updated_at":"2023-08-05T18:27:13.426Z","dependencies_parsed_at":null,"dependency_job_id":"67bd4b87-5832-4625-89b2-4365989d2466","html_url":"https://github.com/ridays2001/ht-site","commit_stats":null,"previous_names":["ridays2001/ht-site"],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ridays2001%2Fht-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ridays2001%2Fht-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ridays2001%2Fht-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ridays2001%2Fht-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ridays2001","download_url":"https://codeload.github.com/ridays2001/ht-site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229404258,"owners_count":18067680,"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":["bootstrap","expressjs","javascript","nodejs","portal","pug","student-information-system"],"created_at":"2024-12-12T15:16:08.443Z","updated_at":"2025-12-30T20:28:53.038Z","avatar_url":"https://github.com/ridays2001.png","language":"Pug","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HT - Site\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat+square)](http://makeapullrequest.com)\n\nThis project dates back to 22nd June 2020, but was recently rebased and force updated due to some security issues.\n---\n\n\u003cbr\u003e\n\n### Live version:\nThe live version of the site can be found [here↗](https://ht-site.herokuapp.com/).\n\n\u003cbr\u003e\n\n*Username* - test\\\n*Password* - test\n\n\u003cbr\u003e\n\n### Technologies used:\n*Backend:*\n+ Javascript (Node.js - Main)\n+ Express.js (Backend structure)\n+ Google Firestore (Database)\n\n*Frontend:*\n+ Pug (HTML template engine)\n+ Bootstrap (CSS framework)\n+ Custom CSS\n+ jQuery\n\n*Others:*\n+ [Heroku](https://heroku.com/) - Hosting the site.\n+ [Freenom](https://freenom.com/) - Domain name.\n+ [Cloudflare](https://cloudflare.com/) - SSL certificate.\n+ [Sentry](https://sentry.io/) - Error management.\n+ [ESLint](https://eslint.org/) - Code formatting.\n+ [Font Awesome](https://fontawesome.com/) - Free icons.\n\n\n### Requirements:\n+ [Node.js][1] - v14 or higher\n+ [Google Firebase][2] - Configure database.\n\n### Instructions to run the site:\n**PLEASE NOTE:** In some steps, I have asked y'all to save some details or files for later.\nYou need to make sure that they are saved in a secure place.\n**Do not** share them with anyone else and **do not** commit them to GitHub.\n\nTo run this site locally, follow these rules:\n#### 1. Configure node:\n+ Go to [nodejs↗][1] site.\n+ Download and install it for your pc.\n+ Be sure to install v14 or higher.\n\n#### 2. Configure your database:\n+ Go to [firebase console↗][2].\n+ Setup a project with some basic settings.\n+ Click on the settings icon in the right sidebar.\n+ Go to Project Settings \u003e Service Accounts\n+ Under the \"Firebase Admin SDK\", look for a \"Generate new private key\" button.\n+ Download the json configuration file.\n\n#### 3. Configure sentry:\n+ Go to [sentry↗](https://sentry.io/) and sign in.\n+ Setup an express project following some basic instructions.\n+ Save the sentry dsn url somewhere for later.\n\n#### 4. Get a discord webhook:\n+ We use Discord Webhooks to send all contact form data directly to your server.\n+ If you want to opt out of this step, go to src/routers/contact.js and remove the Discord Webhook section.\n+ You would need to use the **desktop version** of discord to manage webhooks.\n+ Go to [Discord](https://discord.com/) and sign in.\n+ Go to a server where you have *MANAGE_WEBHOOKS* permission, or create your own server.\n+ Create a channel \u003e Go to channel settings \u003e Webhooks and create a webhook.\n+ Name the webhook whatever you want and you can also optionally provide an image.\n+ Copy the webhook link and save it somewhere for later.\n\n*Note: You can replace the /api/webhooks/ with /api/v7/webhooks to get more descriptive errors while testing new features.*\n\n\u003cbr/\u003e\n\n\u003cimg src='https://i.imgur.com/c6TPFqp.png' width='300' align='right' alt='Fork' /\u003e\n\n#### 5. Fork this repository:\n+ Make sure that you're logged in to GitHub.\n+ Click on the fork button at the top right corner.\n+ You will see the forked version in your repositories section.\n\n\u003cimg src='https://i.imgur.com/sH5CBeg.png' width='275' align='right' alt='Download'/\u003e\n\n#### 6. Download code:\n+ Go to your profile \u003e repositories section.\n+ You will see the forked version of the code.\n+ Open it and click on the download code button.\n+ Select your desired method to download it.\n\n\u003cbr/\u003e\u003cbr/\u003e\n\n#### 7. Configure your environment:\n+ Make a new `.env` file in the folder.\n+ Configure it by following [this example↗](https://github.com/ridays2001/ht+site/blob/master/.env.example).\n+ Paste the links, passwords, and other configuration information which we have saved from previous steps.\n+ __**DO NOT**__ commit this file to GitHub.\n+ __**DO NOT**__ share this file with anyone else.\n+ Make sure *your* folder structure is *similar* to *this repository*.\n+ Open your terminal in the project folder. \\[For windows - Right click in explorer \u003e open command prompt here].\n+ Use `npm i` to install all the dependencies for the project.\n+ Start the site by using `npm start`.\n+ Minimize the terminal and open your browser to [localhost↗](http://localhost/).\n+ If you followed the steps correctly, you should see the site homepage.\n\n\n### Contribute:\nIf you feel like you can change something to a better version, even if it is a comment to explain a function better, feel free to submit a pull request.\n+ Edit the code from the forked repository.\n+ Make a new branch with your code changes.\n+ Click on pull request button.\n+ Submit it!\n\nThank you for contributing. 💙\n\u003cbr/\u003e\n\n\u0026copy; 2020 Riday.\n\u003cbr/\u003e\u003cbr/\u003e\n\n\u003ca href='https://discord.gg/muuyMD9'\u003e\n\t\u003cimg src='https://i.imgur.com/0Ed3Cct.png' width='300' alt='Discord - Riday 💙#7468'\u003e\n\u003c/a\u003e\n\n[1]:https://nodejs.org/en \"Node.js official site.\"\n[2]:https://console.firebase.google.com/ \"Google firebase console.\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fridays2001%2Fht-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fridays2001%2Fht-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fridays2001%2Fht-site/lists"}