Here you will find some useful resources that may help you and your team to kick-off your project.

Project's Manifesto

Your project manifesto is a document targeted mostly to newcomers so they can start working without inconvenience.

Your project's manifesto should include all necessary instructions in order to set up the project, run it, run tests, etc.

How to implement a manifesto in my project

Just copy the following Template page and adapt it to your project.

Template

Development workflow guidelines

GitFlow

We follow Gitflow's branching model for our projects. You can read about it here.

Continuous Delivery

Continuous Delivery (CI) is the ability to get changes of all types (including new features, configuration changes, bug fixes and experiments) into production, or into the hands of users, safely and quickly in a sustainable way. We recommend every project to set up a CI.

Docker

We prefer containerizing our applications using Docker, and Docker Compose for more complex applications.

You can start your app find some good Docker Compose examples for Django. For specific applications you can also refer to the Docker samples page.

Setting up macOS

If just got a new MacBook, you should set up it correctly. This list covers the bare minimum requirements for developing a web application in a macOS based system.

  1. Install Slack and sign up with your sophilabs email address.