ReverieHacks Software development

ReverieHacks Software Development is a traditional hackathon experience where you and your team are working together to create a software solution.

Participating

Building your project

The first step to participating comes through identifying the context of your problem. Many of you might already have a good idea of what the contexts of your problem are, however for those who are still unsure, we have included a problem statement template that can help you get started.

After you have identified the problem, we want you to create a github repository where your project is located. It is good practice to use github since it will allow you to easily collaborate and work with others efficiently, and it will save you from hastle in the future for the submission process. If you're new to using git, we reccomend checking out github desktop since it's an easy way for beginners to get started with using github.

Now the ball is in your court. You are free to design a program as you like as long as you follow the guidelines for the Software development track.

It is vital that you add a license for your open source project. You can choose your own license or use the MIT license which is a great license for open source projects


Submitting your project

The uploading process can be carried out easily on Devpost under the respective track. Simply upload the following files for a successful submission

Code Repository :

Upload the complete project code to a version control platform such as GitHub, GitLab, or Bitbucket. Ensure the repository is accessible and includes necessary instructions.

Demo video :

Create a video that demonstrates the functionality of the software. The video should highlight key aspects and use cases.

Project Documentation:

Provide a detailed Project documentation that includes information like purpose, target audience and main features, but also technical things like installation guides, user manuals, references and any configuration or setup instructions.

Guidelines

Guidelines for building your project

These are guidelines that we have added that you must abide by to ensure a fair competition for all. To reach out to us, you can join the discord or reach out to us on our email

  • Code should be well-documented, clean, and follow best practices. Teams should include comments and documentation to explain their code.

  • Teams are encouraged to use version control systems like Git/github. Regular commits and clear commit messages are recommended.

  • All submissions must be the original work of the team. Plagiarism or any form of cheating will result in disqualification.

  • Teams can use open-source libraries and tools but must provide proper attribution.

  • Mentors will be available to provide guidance and support throughout. Teams are encouraged to seek help from mentors

  • All projects must be submitted by the designated deadline. Late submissions will not be considered unless there are extenuating circumstances

  • You can find us on our discord regarding any complaints, feedbacks and sugestions!