https://github.com/hacksu/kenthackenough
The world's best hackathon website.
https://github.com/hacksu/kenthackenough
Last synced: about 2 months ago
JSON representation
The world's best hackathon website.
- Host: GitHub
- URL: https://github.com/hacksu/kenthackenough
- Owner: hacksu
- License: mit
- Created: 2015-02-03T17:48:47.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T09:12:33.000Z (about 2 years ago)
- Last Synced: 2025-01-05T10:12:24.883Z (3 months ago)
- Language: JavaScript
- Size: 27.8 MB
- Stars: 6
- Watchers: 7
- Forks: 11
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hackathon - Kent Hack Enough - Legacy registration and staff management API for HackSU events. (Platforms / Unmaintained 🧊)
README
```
git remote add live ssh://[email protected]/var/www/kenthackenough.git
git push live master
```
## The following information is likely out of date
---
The world's best hackathon website.
[]()
## About
This API was made in an effort to ease the organization of Kent Hack Enough as we continue to grow in size. This project was built by Paul Dilyard (@pdilyard), and is currently maintained by HacKSU leadership.
## Installation
First, make sure that the appropriate version of Docker is installed (consult Google if you aren't sure what to install on your OS).
Next, clone the repository
``` git clone https://github.com/hacksu/kenthackenough.git ```
After cloning the repository, navigate into it and install the npm packages
``` cd kenthackenough ```
``` npm install ```
Finally, you'll want to set up a `config.js` file
``` cp config/config_example.js config/config.js ```
Then edit `config/config.js` and enter your desired values
You should now be ready to run the API and contribute to the code!
## Running
Running the API is very simple thanks to Docker
Then, you'll want to set up a `config.js` file
``` cp config/config_example.js config/config.js ```
Then edit `config/config.js` and enter your desired values
Simply run
``` docker-compose up ```
to start the API, and then
``` docker-compose down ```
to stop the containers.
If you make changes to the config file or any other file in the project, make sure to run
`docker-compose build` to ensure that those changes got copied to your container!
Then you're ready to restart the container with `docker-compose up`
## Documentation
See the repository's [Wiki](https://github.com/hacksu/kenthackenough/wiki) for detailed documentation.