J
J
joha07382021-10-12 18:06:50
PostgreSQL
joha0738, 2021-10-12 18:06:50

How to properly prepare your project for uploading to GITHUB?

I am a person with no work experience, but I have a couple of web applications with a database that I want to upload to GITHUB for at least some kind of portfolio, but I don’t know how to “build” the project correctly so that other people can download it and see how it works. The main question revolves around the database, because the database is on my PC and in the application.properties settings for connecting to this database, and when downloading to another PC, it will not find and give errors without even starting.
I would be grateful for links to any articles or videos, as I could not find anything.

Answer the question

In order to leave comments, you need to log in

1 answer(s)
A
Alexey Cheremisin, 2021-10-12
@joha0738

1) Put the database schema and test data in the form of sql files into the project, or make a utility to load them from some json/xml/yaml/edn/etc...
2) Write the Readme.md file, in which you describe the settings, where they lie and how to fill in the circuit and test data. Specify the requirements for the project, how to build, what types of databases to use, what versions of Java, etc.
3) Try to build your project without using the development environment, only from the console using maven, gradle or whatever you use there (ant?).
4) Be sure to specify the class to run with the main method, or specify it in the assembly file
5) Upload the project to github and ask someone to test it
6) Optional, but they also sometimes look at tests. If they are, do not deny the pleasure and shove them into the project.
Java programmers, they are smart, they can tinker with maven, gradle, and properties.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question