Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leognmotta/hackatuning
Open source hackathon management system
https://github.com/leognmotta/hackatuning
Last synced: about 1 month ago
JSON representation
Open source hackathon management system
- Host: GitHub
- URL: https://github.com/leognmotta/hackatuning
- Owner: leognmotta
- License: mit
- Created: 2019-09-10T19:11:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T12:34:02.000Z (about 2 years ago)
- Last Synced: 2024-12-03T10:36:45.137Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://hackatuning.com
- Size: 4.29 MB
- Stars: 10
- Watchers: 1
- Forks: 5
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hackathon - Hackatuning - Early stage hackathon management platform. `js` (Platforms / Open Source 🌳)
README
A project by:
[Leonardo Motta](https://leomotta.me), [Adam Dias](https://github.com/adamdias), [Rafael Prado](https://rprado.myportfolio.com/)
## [See the prototype project](https://hackatuning.com/)
Hey there, hackatuning is an open source hackathon management system.
### **Creating and managing hackathons is easy!**
Did you have trouble organizing a hackathon? Did you have trouble finding a team or member for your team? Outdated or old tools? Would you like to tuning your hackathon?
### We created [Hackatuning](https://hackatuning.com)! A cross-platform solution to simplify, optimize and enhance the hackathon experience by:
- Create and manage hackathons
- Join hackathons
- Find a team
- Create team and find specific member
#### With the latest technologies!
---
## [Watch the Trailer](https://vimeo.com/361611891)
---
## How to run the project
The project is a mono repository, you will need to run `yarn install` or `npm install` in both frontend and backend directory.
The frontend will need to know where to call the api, for that use the `API_URL` environment, and that is all, you may now run `yarn start` or `npm start`.
The backend will need more environment variables, `APP_URL` to know the url where the api is running, `WEB_URL` to know where our frontend is running, for cors proporse and the `NODE_ENV` which should be either production or development.
All routes will have a `v1` prefix eg. `http://localhost:3333/v1/route`.
To connect environment variables to connect to a SQL database with sequelize.
```js
DB_DIALECT=postgres
DB_HOST=
DB_USER=
DB_PASS=
DB_NAME=
```
To connect to MongoDB:
```js
MONGO_URL=
```
To connect to Redis database for background tasks such as sending emails.
```js
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
```
To send emails via smtp with nodemailer, choose any smtp provider you want:
```js
MAIL_HOST=
MAIL_PORT=
MAIL_USER=
MAIL_PASS=
```
## MIT License
[Copyright (c) 2019](https://github.com/leomotta121/hackatuning/blob/develop/LICENSE)
[Leonardo Motta](https://leomotta.me), [Adam Dias](https://github.com/adamdias), [Rafael Prado](https://rprado.myportfolio.com/)