How to set up a coreBOS development environment

development git gitHub code webservice unit tests

The purpose of this blog post is to help everyone have an empowering and welcoming first experience as they start contributing to the coreBOS Open Source project!
Have a look at the wiki documentation if you want to read a more detailed information about setting up your coreBOS development environment using Git.

  • What you’ll learn
    • How to access the code of a coreBOS install.
    • How to access this coreBOS install via web services.
    • How to execute all the unit tests accessing the demo data.

  • What you’ll need
    • LAMP(Linux, Apache, MySQL, PHP) stack.
    • Code editor, anyone you prefer and work with.
    • And obviously, you need to have Git installed because coreBOS is a git-based open source project. That means that contributing to the project is basically the same as for any other git-based project.

To set up a development install for coreBOS you will need to take these steps:

  • fork the project on GitHub
  • clone your fork on your local development computer
  • set the permissions on the files so your user is the owner of all files (so you can edit them normally with your user) and the webserver user is the group (so it can write the files it needs to write to work) 
    chgrp -R www-data <name of directory where you cloned the corebos repo>
  • install the project as you would normally
  • once you can log in, drop to the command line (we we assuming Linux here)
  • move the renamed install directory and file back to their original place:
    • the directory “install” and the file “install.php” will be renamed after the installation is complete to something like 8432658395801x3fab13af3.42704102install for security reasons. Rename them back to their original name: 
      mv 8432658395801x3fab13af3.42704102install/ install
      mv 8432658395801x3fab13af3.42704102install/ install
    • now, rename Migration directory back into the modules directory: 
      mv 8432658395801x3fab13af3.42704102Migration modules/Migration
  • change to build directory and delete the coreBOSTests directory. 
    git clone https://github.com/tsolucio/coreBOSTests coreBOSTests
  • drop the database and load the one you will find in build/coreBOSTests/database/coreBOSTests.sql
  • from the root directory of your install run the commands: 
    build/HelperScripts/createuserfiles
    build/HelperScripts/update_tabdata
  • finally, go to the root of your web server and install the coreBOS Webservice Development tool with: 
    git clone https://github.com/tsolucio/coreBOSwsDevelopment
  • import the project code into your IDE and you are ready to start developing.

Welcome to the coreBOS development team! :-)

Now, go forth and build!

What if you get stuck? That’s perfectly fine.

Don't hesitate to get in touch, we are a really friendly and helpful community. :)

We look forward to seeing your code!

Previous Post Next Post