https://github.com/renuo/applications-setup-guide

Renuo Applications Setup Guide
https://github.com/renuo/applications-setup-guide

best-practices how-to r-wg-education setup-guide

Last synced: about 2 months ago
JSON representation

Renuo Applications Setup Guide

• Host: GitHub
• URL: https://github.com/renuo/applications-setup-guide
• Owner: renuo
• Created: 2016-01-29T16:54:08.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-07-12T11:33:00.000Z (2 months ago)
• Last Synced: 2024-07-12T13:23:33.333Z (2 months ago)
• Topics: best-practices, how-to, r-wg-education, setup-guide
• Language: Ruby
• Homepage: https://renuo.github.io/applications-setup-guide
• Size: 9.12 MB
• Stars: 17
• Watchers: 7
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Security: security.md

Awesome Lists containing this project

README

        
# Renuo Applications Setup Guide

This repo is the [Renuo](https://www.renuo.ch) collection of best-practices to set-up apps.

We are a [Rails company](https://rubyonrails.org/foundation), so the most value probably

will be found in the parts concerning Rails. But anyways you'll also find a lot about the

inner workings of Renuo.

* [Ruby on Rails – App Setup Guide](./ruby_on_rails/README.md)

## Some Notes on the Side

If you are reading this document, it means that you have to setup a new application.

A new project started and it's now time to set everything up so that **everyone**,

in your team, **can start working on it**.

This document will try to be as minimalist as possible and provide you with all the steps to set up the application as

fast as possible. There are things, in Renuo projects, which are mandatory, other that are suggested.

The basic things that need to be ready before the team can start working on a project are:

* An existing *git* repository containing the project

* Two branches: *main* and *develop*

* A README with essential information about the application

* Convenience-scripts: `bin/setup`, `bin/check`, `bin/fastcheck`, `bin/run`

* One running, green test

* Continuous integration (*CI*) ready, running and green for both branches

* Continuous deployment (*CD*) ready and running for both branches

* The application deployed for both branches

As an appendix, you'll find a [checklist](checklist.md) you can use to follow the guide.

**:exclamation: Do not blindly follow this guide, always think about what you are doing and why.

If you think something is wrong or simply outdated, improve this guide with a Pull Request.**

We want you to know exactly the reason behind each single step of this guide.

Thank you for your work and have fun! :tada:

## License

[Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode)