Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/launchpadlab/alejandro-lpl-backend


https://github.com/launchpadlab/alejandro-lpl-backend

Last synced: 3 days ago
JSON representation

Awesome Lists containing this project

README

        

## Getting Started
### Initial Project Setup
If you created this project, instructions for setting up GitHub, Heroku, and other integrations can be found in the **[Project Setup Checklist](PROJECT_SETUP_CHECKLIST.md)**.

### Running in Development

- `git clone [email protected]:LaunchPadLab/.git`
- `cd `
- `bundle install`
- `load_secrets`
- `bundle exec rake db:create db:migrate db:seed`
- `rails server`
- `open localhost:3000`

### Development Workflow

#### Pull Requests
This repo contains a template for Pull Request (PR) descriptions to help you to give easy and consistent instructions and context to a Code Reviewer and QA Reviewer.
More information on PR best practices for both Authors and Reviewers are included in the [LPL Pull Request Guidelines](https://github.com/LaunchPadLab/opex-public/blob/master/gists/pull-request-guidelines.md).

#### Committing
Pull requests to the `dev` branch will trigger review apps in Heroku.
The `staging` branch will auto-deploy to the *staging* environment on Heroku.
The `main` branch can then be deployed to *production* after successful QA.

#### Testing
All Ruby/Rails unit tests must pass for a PR to be merged. They can be run locally with:

- Ruby/Rails unit tests: `bundle exec rspec`

#### Linting
The project is set up to lint ruby, so its advised that you have this integrated in your editor.
Currently, linting errors will not block a PR merge, but this may change in the future.

You can run these manually with:
- Ruby: `rubocop` (if installed globally with `gem install rubocop`)