https://github.com/hacktx/nucleus

Hackathon application and user information system
https://github.com/hacktx/nucleus

Last synced: about 1 month ago
JSON representation

Hackathon application and user information system

• Host: GitHub
• URL: https://github.com/hacktx/nucleus
• Owner: hacktx
• License: epl-1.0
• Created: 2015-07-12T22:15:59.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-03-25T16:18:04.000Z (almost 9 years ago)
• Last Synced: 2024-03-27T09:55:06.455Z (10 months ago)
• Language: Hack
• Homepage:
• Size: 3.51 MB
• Stars: 51
• Watchers: 18
• Forks: 13
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hackathon - Nucleus - Hackathon application system that integrates with MyMLH, Slack and more from HackTX. (Platforms / Unmaintained 🧊)

README

        
![Nucleus](nucleus.png)  

[![Software License](https://img.shields.io/badge/license-EPL-brightgreen.svg)](LICENSE)

[![Code Climate](https://codeclimate.com/github/hacktx/nucleus/badges/gpa.svg)](https://codeclimate.com/github/hacktx/nucleus)

[![Dependency Status](https://gemnasium.com/hacktx/nucleus.svg)](https://gemnasium.com/hacktx/nucleus)

Hackathon attendee identity system and application portal

## Installation

### Setup Environment

You can find instructions to setup the Nucleus environment on the [wiki](https://github.com/hacktx/nucleus/wiki/Environment-Setup).

### Setup configurations

In the root of the project folder, there it the file `exampleconfig.ini`. Copy this to `config.ini` and fill out the desired fields. The DB fields are necessary for the service to run.

### Install dependencies

In the root of the project folder, run `composer install` to install the PHP dependencies, and `npm install` for the frontend dependencies.

### Build the Frontend

In the root of the project folder, run `gulp build` to compile the frontend.

#### Learn more about how Nucleus works on [the wiki](https://github.com/hacktx/nucleus/wiki/How-Nucleus-Works).