This repository was created in the summer of 2016 by David Melisso to replace the old Harker Robotics website which was made using Wordpress. Although there were multiple robotics websites before that, they were mostly for the Purchase Request system and wikis. This repository created a combined location for an external website for outreach and an internal website for systems.
The website was updated in the summer of 2019 by Chirag Kaushik with a new design for the external facing website and a member attendence system.
The website uses Node.js for backend and Bootstrap 3.3 + JQuery for the frontend. More info can be found in the Setup section. The new external facing website uses vanilla Javascript and CSS.
The website can be found at robotics.harker.org and is currently being maintained by Kabir Ramzan and Aarav Borthakur.
Follow this tutorial by mongoDB on how to install mongoDB onto your computer. For your reference, mongoDB is the database program used by this repository. Ensure that the mongod process is running before starting up the website. The tutorial explains how to run the mongod process.
First, go to the Node.js download page. You will see two download links, download the one titled "LTS" or "Long Term Support".
As of January 8, 2018, this program works successfully on versions 7.4.0 and 8.9.0 of Node.js. In the future, this program should be updated to work successfully on future verisons of Node.js. You can check the version of node you are running by entering the command node -v into your terminal or command prompt.
In your file browser (Finder in macOS, File Explorer in Windows), locate the folder of this repository. Within the folder, copy the file exampleconfig.json and paste it as config.json. In the new file, change the value next to superadmins from [email protected] to your Harker gmail address. Also, if you wish to run the internal parts of the website (Blog, PR's, etc.), you will have to contact the webmaster for Google API information (specifically, google.clientID and google.secretKey, and the blog API key if you wish to run the blog). The other values of the config file are explained in the Config section.
In your terminal (or command prompt), change your working directory (cd) to the folder for this repository. Then, enter the command npm install. This uses the node package manager to install the packages required to run this program.
With your terminal's working directory still being that of the repository, enter the command npm i and then npm start. Then, go to localhost in your web browser. The website should appear.
This folder contains the mongoDB models (using mongoose). This tutorial explains how to make models in Node.js using the mongoose package.
The different express routers. They should be included (using require) in index.js. This tutorial explains how routing works using the express package. Note that we are using routers, so instead of app you would use the variable router, which should be initialized using express.Router().
If you are solely looking to work on the scouting app, this will either be part of the member.js code or be in a new file under /routers/member/.
The static files (images, css files, js files, etc.) which are accessed directly through the website. For example, if a file was placed in /static/foo/bar/file.txt, the file could be accessed on your device through localhost/foo/bar/file.txt. This tutorial explains how express handles statically served files.
The ejs files which store the front-end (HTML, rendered with ejs). Learn more about ejs here.
The actual pages that will be rendered and displayed. These files are displayed using res.render() in the /controllers folder.
Note that the scouting app page will be in /views/pages/scouting.ejs.
The snippets of HTML (may include ejs) which are included in the pages within /views/pages. They are included using <%- include(__base + 'views/partials/example.ejs') %>, except example.ejs would be replaced with the name of the file. This is good for snippets which are repeated, like navbars, footers, and <head> content.
The config file should be stored as config.json. You can copy from the example in exampleconfig.json. Make sure you understand how JSON works before manipulating the file. Here are the settings and what they mean:
| Field | Value | Description |
|---|---|---|
| google.clientIDs | ["GoogleClientID"] | The google client IDs used for "sign in with Google". Ask for it from the webmaster if needed. Only needed if server.runInternal is set to true. |
| google.displayID | 0 | The index of the client id in the array google.clientIDs which to use to display on the website |
| google.secretKey | "secret" | The key given by google for "sign in with Google". Ask for it from the webmaster if needed. Only needed if server.runInternal is set to true. |
| captcha.sitekey | "6LeBUaYZAAAAAPJ86mgUDGSVncmg4VeOo-0651kt" | The sitekey for captcha display on the contact form. |
| captcha.secret | "secret" | The secret for captcha verification on the contact form. |
| cookie.secret | "secret" | The secret to use in your cookies. Make sure it has high entropy (very long and random). |
| cookie.name | "Harker1072Robotics" | The name of the cookies. |
| server.domain | "localhost" | The domain that the server is running on. If you are running this on your local machine, "localhost" will do. |
| server.production | false | Whether the server is a production server, meaning it is behind a proxy and being used as the robotics website. |
| server.port | 3000 | the port to run the system on |
| server.runInternal | false | Whether to run the /member path (which includes all stuff which is required to login to see, like PR's and the scouting app). |
| TBA.apiKey | "key" | the API key for TBA |
| blog.runBlog | true | Whether to run the blogs with the API or the iframe |
| blog.interval | 100 | The interval (in seconds) on which to pull the blog posts from Blogger. |
| blog.blogID | "2019535614975828896" | The ID number for the blog. Use this tutorial to find the ID number of the blog, or ask the webmaster. |
| blog.apiKey | "key" | The API key used to access the blog through API. Ask the webmaster if needed. |
| database.port | 27017 | The port on which mongoDB runs. |
| database.databaseName | "robotics-website" | The name of the database used for this program. |
| automail.singleMentorMail | true | Whether to send the email for purchase requests to a mentor once per day or after every purchase request (set to true if only once per day) |
| automail.cronPattern | "0 17 * * *" | The cron pattern for scheduling emails if automail.singleMentorMail is true (use the example value to send at 5 P.M. every day). |
| automail.auth.user | "[email protected]" | The email address to send from |
| automail.auth.pass | "password" | The password of the nodemail user |
| photos.host | "https://photos.harker.org" | The website hosting the photos of students |
| photos.auth | "key" | The API key used to access the photos |
| users.admins | ["[email protected]", "[email protected]", "[email protected]"] | The array of google email addresses of the admins. |
| users.mentor | "[email protected]" | The email address of the mentor. |
| users.superadmins | ["[email protected]", "[email protected]", "[email protected]"] | The array of google email addresses of the webmasters of the project. Grants special access for testing purposes. |
Harker Robotics' apps use @harker-robo/prettier-config for standardized code style. To format your code:
npm run format