Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ScientificClubofESI/LaraHack
Administration system for Hackathons :chart_with_upwards_trend: !
https://github.com/ScientificClubofESI/LaraHack
admin-dashboard administration checkin competition hackathon hackathon-application registration
Last synced: 6 days ago
JSON representation
Administration system for Hackathons :chart_with_upwards_trend: !
- Host: GitHub
- URL: https://github.com/ScientificClubofESI/LaraHack
- Owner: ScientificClubofESI
- License: agpl-3.0
- Created: 2019-03-18T00:13:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T05:38:24.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T07:10:36.480Z (3 months ago)
- Topics: admin-dashboard, administration, checkin, competition, hackathon, hackathon-application, registration
- Language: PHP
- Homepage:
- Size: 2.05 MB
- Stars: 118
- Watchers: 6
- Forks: 35
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hackathon - LaraHack - Administration system designed especially for hackathons and similar competitions. (Platforms / Unmaintained 🧊)
README
## We are looking for maintainers!
In order to ensure active development going forward, we are looking for maintainers to join the project. [Please contact the project owner if you are interested.](mailto:[email protected]) and see [CONTRIBUTING.md][contribute] for information on what you can do about that.
**LaraHack** is a complete administration systems designed especially for hackathons and similar competitions .
For participants , it's a clean and simple to submit application with or without team and confirm attendance .
For Organizers , it's an easy way to create your hackathon website , view registrations , analyze statistics , Check-In and much more !
# Features
- **WebSite Template** : LaraHack has a website template that contains all necessary sections ( About,Challenges,Sponsors.. ) with a clean code so you can modify and customize it .
- **Registration** : With LaraHack hackers can register easily with or without a team through a register view that is similar to TypeForm and also.
- **Statistics** : The admin has access to a lot of statistics about registration such us registrations rate per day , decisions about hackers ... and muc more !
- **Dashboard** : Admin can view all applications to the hackathon , take a decision and export data to Excel or CSV .
- **Mailing** : LaraHack is able to send emails such as :
- Successful application: which is sent to every hacker who apply , informing him that his application is done successfully and providing him with his team's name and team's code if he choosed to register with a team .
- Decision : Waiting list , Rejected Or Accepted with confirm attendance link .
- **Check-In** : Allows organizers to check the participants present at the event day .
- **Settings** : Configure some essential settings ( at the moment it contains only the possibility to close or open registrations ) .
# Screenshots
# Setup
### Quick deploy with Heroku
[](https://heroku.com/deploy?template=https://github.com/ScientificClubofESI/LaraHack)
### Requirements
| Requirement | Version |
| ------------------------------------------- | ------- |
| [PHP](https://www.php.net) | `7.1+` |
| [Composer](https://getcomposer.org) | `1.8+` |
| [MySQL](https://www.mysql.com) | `8.0+` |
Run the following commands to check the current installed versions:
```bash
php --version
```
For MySQL You can run this command in MySQL Commande Line Client :
```bash
select version() ;
```
### Deploy locally
Getting a local instance of LaraHack up and running is very quickly ! Start By Creating A Database on MySQL and go with these steps :
1 - Clone the repository and cd to the project folder:
```bash
git clone https://github.com/ScientificClubofESI/LaraHack
cd LaraHack
```
2 - Install the necessary dependencies:
```bash
composer install
```
3 - Create your `.env` file from `.env.example` and generate an app key ( Don't forget to configure it with the database, and your email , if the host is googlemail so let mail driver , host and port as it was in env.example ) :
```bash
cp .env .env.example
php artisan key:generate
```
4 - Migrate the database and start listening a queue in different terminal :
```bash
php artisan migrate
php artisan queue:listen database
```
5 - Finally run the server :
```bash
php artisan serve
```
### Deploy Using Docker
Getting a local instance of LaraHack up and running is very quickly using docker-compose
1 - Clone the repository and cd to the app folder:
```bash
$ git clone https://github.com/ScientificClubofESI/LaraHack
cd LaraHack
```
2 - Change the ownership of the app:
```bash
$ sudo chown -R www-data:www-data 'LocalAppPath'
'LocalAppPath' ex: ~/LaraHack
```
3 - copy the config file:
```bash
$ cp .env.example.docker .env
```
4 - Mount the app directory and install the dependencies:
```bash
$ docker run --rm -v $(pwd):/app composer install --no-dev
```
5 - Build the app image and run the services:
```bash
$ docker-compose up -d
```
# Customizing for your event
### Hackathon name
Don't forget to put your hackathon name in environment variable `APP_NAME` ( `.env` file )
### Hackathon Logo
Put your hackathon logo in the folder `/public/images` with the name of `LOGO.png`
### Hackathon Landing Page
You find the hackathon landing page section in the folder `/resources/views/sections` with a clean and simple code
### Mail Content
To customize the decision and confirmation emails for your event, edit email templates in
`/resources/views/emails`
## Notes :
- Access to the admin dashboard via the link `/admin`
- The default mail and password are : `[email protected]` and `cse` you can change them in the migrations folder `database/migrations`
# Contributing
Do you have a feature request, bug report, or patch? Great! See
[CONTRIBUTING.md][contribute] for information on what you can do about that.
Contributions to LaraHack are welcome and appreciated !
# Feedback / Questions
If you have any questions about this software, please contact [email protected] or [email protected] .
# License
Copyright (c) 2019 Scientific Club Of ESI (https://github.com/ScientificClubofESI). Released under AGPLv3. See [`LICENSE`][license] for details.
[contribute]: https://github.com/ScientificClubofESI/LaraHack/blob/master/CONTRIBUTING.md
[license]: https://github.com/ScientificClubofESI/LaraHack/blob/master/LICENSE