项目作者: ideahacks

项目描述 :
Website for IDEA Hacks, UCLA's annual hardware-focused hackathon
高级语言: Handlebars
项目地址: git://github.com/ideahacks/ideahacks.la.git
创建时间: 2017-07-10T03:01:30Z
项目社区:https://github.com/ideahacks/ideahacks.la

开源协议:

下载


IDEA Hacks Website

Build Status
JavaScript Style Guide
styled with prettier

Setting up the development environment

  • Make sure you have an up-to-date version of Node installed. node --version
    must be at least 16.17.0, which is the LTS version.
  • Clone this repo with git clone https://github.com/ideahacks/ideahacks.la.git
  • Change into the repo directory with cd ideahacks.la
  • Run npm ci to install the project’s dependencies.
  • Create a development.json file within the folder ideahacks/config (see below)
  • Run npm run dev to start the server. Changes you make will automatically
    restart the server.
  • Visit localhost:3000 to view the site.
  • Run npm run test to check formatting and run ESLint, which will catch common
    errors.

development.json

Make sure you have a development.json file within the folder ideahacks/config
— it contains private configuration variables that can’t be pushed onto GitHub,
so you’ll have to create it in order to run the project locally. It looks like:

  1. {
  2. "dbURI": "INSERT_URI_HERE",
  3. "sessionSecret": "INSERT_SECRET_HERE",
  4. "host": "localhost:3000",
  5. "SENDGRID_API_KEY": "INSERT_API_KEY_HERE",
  6. "GOOGLE_CLIENT_ID": "INSERT_ID_HERE",
  7. "GOOGLE_CLIENT_SECRET": "INSERT_SECRET_HERE"
  8. }

Remote database connection

This project connects to a remote database. Connection to this remote database
requires WIFI internet connection (as opposed to WEB).

  1. UCLA_WIFI will work
  2. UCLA_WEB will not work

If you see error messages in your console about failure to connect to the
database, this is likely the issue. It might also be because you don’t have
necessary permissions.

Deployment

Currently this website is hosted on Heroku, a cloud hosting service. Heroku is
configured to automatically deploy this repo on its development and
production branches.

  1. production: ideahacks.la
  2. development: ideahacks-test.herokuapp.com