This repository encapsulates a monolithic implementation of the QHacks Hacker Dashboard. This dashboard is to serve as a hub for judges, mentors, partners and hackers participating in QHacks. The dashboard implements a suite of features to make the process and experience of attending a hackathon a richer and more pleasant one.
The back end application is built using a Node server using Express to serve a RESTful API. The front end is implemented using ReactJS, and Redux for state management, all of which are bundled with Webpack. For more information about the technical specifications please refer to the wiki.
For development this project uses dotenv to allow you tp specify environment variables in a static file.
NOTE: You will need to create a .env file at the root your project with the desired environment variables that are outlined below. You can check out example.env in the project root to see a standard configuration.
See the environment variables below for the back end to operate:
| Name | Description | Required | Default |
|---|---|---|---|
APPLICATIONS_STATUS |
Whether applications are open to new submissions. Accepts open or closed |
No | closed |
AUTH_SECRET |
The secret used to encrypt auth tokens | Yes | None |
DEV_PROXY |
When running the webpack-dev-server all API calls will be proxied to this host. |
No | http://localhost:PORT |
EMAIL_URL_HOST |
Host to be used in the email urls. | No | None |
MONGO_AUTH_SOURCE |
The database name used to authenticate the connection to MongoDB | No | None |
MONGO_DBNAME |
The database name to use inside the instance of MongoDB. | Yes | None |
MONGO_HOST |
The hostname to use to access the MongoDB instance. | Yes | None |
MONGO_PASS |
The password to access the MongoDB instance. | No | None |
MONGO_PORT |
The port to use to access the MongoDB instance. | No | 27017 |
MONGO_USER |
The username to access the MongoDB instance. | No | None |
PORT |
Port to run the Express sever on. | No | 3000 |
REVIEWS_PER_APPLICATION |
The number of reviews that must be applied to an application before it is considered complete. | Yes | 1 |
SENDGRID_API_KEY |
SendGrid transactional email service api key. | No | None |
SLACK_WEBHOOK_URL |
The webhook URL you wish to send Slack messages to | No | None |
FORCE_SSL |
If this is set to true, then any non-SSL access will be redirected to SSL. | No | 'false' |
There are currently no environment variables needed for the front end, update this as necessary.
However, within the client/assets directory there is semantic-ui/ directory. This holds our theming and customization on top of the default Semantic UI framework. Webpack has been configured to bundle LESS, so we have added the semantic-ui-less package and configured appropriately.
Utilize the scripts below to use the application:
# install dependancies
npm run bootstrap
# run the application in development mode (client and server hot-reload)
npm run dev
# run the server in debug mode
npm run server-debug
# run the application in production mode
npm run start
# runs webpack-dev-server for ui development
npm run client-dev
# build the front end for production
npm run client-prod
# test the server code (lints code, checks for security vulnerabilities in dependencies and outdated dependencies)
npm run test
The application is deployed using the Google Cloud Platform, in order to deploy the application you can run the command:
npm run deploy
NOTE: This assumes you have already installed the GCP SDK onto your machine and configured it to be associated with the account that we deploy the hacker dashboard from, refer the resources here to do that. You will need to contact one of the team members to get this level of access.
This dashboard can send updates about completed basic applications to a Slack webhook URL. To configure this, add SLACK_WEBHOOK_URL to your environment variables. See Configuration/Back End for more information.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
Copyright 2017 QHacks
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.