Thanks to visit codestin.com
Credit goes to github.com

Skip to content

theBrianCui/nucleus

 
 

Repository files navigation

Nucleus
Software License Code Climate Dependency Status

Hackathon attendee identity system and application portal

Installation

Setup HHVM

Nucleus runs on Hack, which requires HHVM. To install HHVM, follow the instructions on their website.

Setup Nginx

All Nucleus requests route through app.php in the root of the project, with static resources being pulled from the public folder. This requires a custom Nginx rule. Here is an example:

server {
  listen 80;

  root /var/www;

  server_name nucleus.example.com;
  include hhvm.conf;

  location / {
    try_files /public/$uri /app.php$is_args$args;
  }
}

Note the include hhvm.conf;. The HHVM install should have created this file in /etc/nginx on installation. If not, these are good instructions on how to configure nginx to use HHVM.

Setup MySQL

Nucleus is backed by MySQL. The schema can be found here. TODO: Add more instructions about MySQL setup.

Install dependencies

Nucleus uses Composer to manage dependencies. Once Nucleus is downloaded, run composer install in the root of the project.

Build the URI Map and Autoloader

Nucleus uses Robo as a task runner and build tool. This should have been installed with the rest of the dependencies from Composer. To generate the URI map, which is required for Nucleus to run, run ./vendor/bin/robo build (or just robo build if you have it installed globally). Creating a controller or updating a controller's path will require a re-build.

Learn more about how Nucleus works on the wiki.

About

Hackathon application and user information system

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Hack 86.0%
  • CSS 12.4%
  • JavaScript 1.4%
  • PHP 0.2%