Как правильно подготовить свои проект для загрузки на GITHUB?

Question

[joha0738]

Я человек без опыта работы, но у меня есть пару веб приложений с БД, которые я хочу загрузить на GITHUB для хоть какого то портфолио но не знаю как правильно "собрать" проект чтобы другие люди смогли его скачать и посмотреть как он работает. Основной вопрос крутится вокруг БД ведь БД на моем ПК и в application.properties настройки подключения к этой БД и при скачивание на другой ПК он не будет находить и выдавать ошибки даже не запустившись.
Буду благодарен на ссылки на любые статьи или видеоролики, тк у меня ничего не получилось найти.

Answer 1

[Алексей Черемисин]

1) Положите в проект схему базы и тестовые данные в виде sql-файлов, или сделайте утилиту для их загрузки из какого нибудь json/xml/yaml/edn/etc...
2) Напишите файл Readme.md, в котором опишите настройки, где они лежат и как залить схему и тестовые данные. Укажите требования к проекту, как собрать, какие типы баз использовать, какие версии явы и прочее...
3) Попробуйте собрать свой проект без использования среды разработки, только из консоли с использованием maven, gradle или что вы там используете (ant?).
4) Обязательно укажите запускаемый класс с main-методом, ну или укажите его в в файле-сборки
5) Залейте проект на гитхаб и попросите кого нибудь его протестировать
6) Необязательно, но в тесты тоже иногда смотрят. Если они есть, не отказывайте в удовольствии и их в проект пихнуть.

Ява-программисты, они умные, могут и в мавен, и в градл, и в пропертях поковыряться.

Comments

[joha0738]

Премного благодарен за подробное объяснение вы очень помогли)

[Алексей Черемисин]

joha0738, ах, да, совсем забыл, в readme упомяните тип лицензии, где нибудь в конце, а также набор библиотек, которые использовали, и для чего. Это сильно облегчает жизнь алчущим вашего проекта.

[Орхан Гасанлы]

Дополню ответ своего коллеги, не забудьте добавить файл .gitignore, где укажите все файлы и директории, которые должны быть проигнорированы. Файлы IDE, внешние лиьы подгружаемые maven & gradle и др. не должны попасть в репозиторий.
Вот, плагин для Intellij IDEA - https://github.com/JetBrains/idea-gitignore