Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 2.39 KB

README.md

File metadata and controls

81 lines (52 loc) · 2.39 KB
Raw

A project by:

Leonardo Motta, Adam Dias, Rafael Prado

hackatuning logo

See the prototype project

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?

hackatuning

We created Hackatuning! 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

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.

DB_DIALECT=postgres
DB_HOST=
DB_USER=
DB_PASS=
DB_NAME=

To connect to MongoDB:

MONGO_URL=

To connect to Redis database for background tasks such as sending emails.

REDIS_HOST=127.0.0.1
REDIS_PORT=6379

To send emails via smtp with nodemailer, choose any smtp provider you want:

MAIL_HOST=
MAIL_PORT=
MAIL_USER=
MAIL_PASS=

MIT License

Copyright (c) 2019

Leonardo Motta, Adam Dias, Rafael Prado