×
Blue Eagle 1.5.2 Released (11 Dec 2018)

The Kunena team has announce the arrival of Kunena Blue Eagle 1.5.2 which is now available for download as a native Joomla extension for Kunena 5.1. This version addresses most of the issues that were discovered in K 1.5.1 and issues discovered during the development stages of K 1.5.2.

× This is for users to help other users, to discuss topics that are related to forum administration in general or problems in running Joomla. This is not the place to ask for Joomla support. If you want assistance with Joomla please ask at forum.joomla.org

Question Offtopic: Github /src/ folder - should i use this or not?

More
9 months 2 weeks ago #1 by shoulders
Hi

I was wondering if you guys can help me on this. I am currently writiing a CRM for myself which is php opensource and on github. I want to know how to set out my files in the repo. Currently they are all in the root.

I have seen some repos on github that use a /src/ folder to hold the actual files i.e. Kunena. Is this now a standard thing to put your files in a /src/ folder to keep things neat and allow external testers to read such files as composer.json, codeception.yml etc.....

Before I go any further I just want to work out wether I should leave everything in the root or like you guys put my CRM files in a /src/ folder.

If you could help that would be great.

Thanks

Please Log in or Create an account to join the conversation.

More
9 months 2 weeks ago #2 by 810
we use the src dir for the main project, all extra dir are having extra functions, like tests for codeceptions test. scripts for developing like symlinks scripts to github clients ect.

The root files are for automatic clients like travis, sonar. Jorobo files are for joomla testing, which its needed by the tests dir.
Then we have .tx thats the translation script, who is merging from the github to the transifex.com website. So the translations are in sync with new strings.

.github is our template for github, there you can template the issue questions on github.
build dir, is our build script for building our components and plugins.
and the last one is docs, but thats a outdated documentation for kunena. we have a new branch for it.
The following user(s) said Thank You: shoulders

Please Log in or Create an account to join the conversation.

More
9 months 2 weeks ago - 9 months 2 weeks ago #3 by shoulders
@810

so if I was starting a new project you would put the main files in a /src/ file because it is neater and better than putting everything in the root?

Here is my project: github.com/shoulders/qwcrm :)
Last edit: 9 months 2 weeks ago by shoulders.

Please Log in or Create an account to join the conversation.

More
7 months 2 weeks ago #4 by shoulders
I am doing my own open source CRM. Would you recommend always putting the actual files in a /src/ folder?

Please Log in or Create an account to join the conversation.

More
7 months 2 weeks ago #5 by 810
If you don't post any other code then your own code, then you don't need src dir.

But if you have docs or tests, then you can better use src dir.
The following user(s) said Thank You: shoulders

Please Log in or Create an account to join the conversation.

More
7 months 1 week ago #6 by shoulders
I found these links that may help other people along with your advice.

Folder Structure Conventions
github.com/kriasoft/Folder-Structure-Conventions

Directory structure for JavaScript/Node Projects
gist.github.com/tracker1/59f2c13044315f88bee9

Please Log in or Create an account to join the conversation.

  • Not Allowed: to create new topic.
  • Not Allowed: to reply.
  • Not Allowed: to add attachements.
  • Not Allowed: to edit your message.
Time to create page: 0.091 seconds