Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make dev #135

Merged
merged 7 commits into from
Jan 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
^.*\.Rproj$
^\.Rproj\.user$
.travis.yml
^_pkgdown\.yml$
^docs$
^pkgdown$
Expand All @@ -12,3 +11,4 @@
^appveyor\.yml$
^\.lintr$
^data-raw$
^docker-compose.yml$
16 changes: 16 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"image": "ghcr.io/rocker-org/devcontainer/r-ver:4",
"features": {
"ghcr.io/rocker-org/devcontainer-features/r-apt:latest": {},
"ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
"packages": "r-cran-rapbase"
}
},
"overrideFeatureInstallOrder": [
"ghcr.io/rocker-org/devcontainer-features/r-apt"
],
"mounts": [
"source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/rstudio/.ssh,type=bind,consistency=cached",
"source=${localEnv:HOME}${localEnv:USERPROFILE}/.gitconfig,target=/home/rstudio/.gitconfig,type=bind,consistency=cached"
]
}
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contributing to rapbase

This outlines how to propose a change to rapbase.
For more detailed info about contributing to this, and other tidyverse packages, please see the
[**development contributing guide**](https://rstd.io/tidy-contrib).
For more detailed info about contributing, please see the
[**tidyverse development contributing guide**](https://rstd.io/tidy-contrib).

## Fixing typos

Expand Down
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.Rproj.user
.Rhistory
.RData
inst/doc
inst/jrxml/*.jasper
vignettes/*.pdf
docs/
docs/
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ remotes::install_github("Rapporteket/rapbase@*release")
Or install the development version from GitHub with:
```r
remotes::install("Rapporteket/rapbase")
```
Alternatively, the package source code can be [cloned from GitHub](https://github.com/Rapporteket/rapbase) and built locally.

## Usage
Once the package is installed functions can be called from within R, *e.g.*:
Expand All @@ -43,6 +41,16 @@ Please provide any comments (*e.g.* on proposed enhancements, shortcomings, erro
## Contributing
If you want to make changes to this project please follow the [Contributing guide](https://rapporteket.github.io/rapbase/CONTRIBUTING.html). Proposed changes will be processed based on manual code reviews. Code that is accepted will be merged into the main branch and used for full scale TESTING and QA prior to making a release for PRODUCTION deployment.

For kick-starting, a development environment set-up is included and may be applied if [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/) is at hand. After cloning *rapbase* the development environment can be startet from a terminal at the local work copy root directory by:
```bash
docker-compose up
```
Navigate a browser to [localhost:8787](localhost:8787), log in to the [RStudio IDE](https://posit.co/products/open-source/rstudio/) and initiate the project by "clicking" the file *rapbase.Rproj* inside the *rapbase* directory. For development all suggested imports for the *rapbase* R package will be needed. To make sure these are installed use the R Console and run
```r
devtools::install_dev_deps()
```
After installing has finished all should be set to start change-build-test iterations :rocket:

## Ethics
Please note that the 'rapbase' project is released with a
[Contributor Code of Conduct](http://rapporteket.github.io/rapbase/CODE_OF_CONDUCT.html).
Expand Down
39 changes: 39 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
version: '3.3'

services:
db:
image: mysql:5.7
command: --innodb-log-file-size=500M --innodb_strict_mode=0
restart: "no"
environment:
MYSQL_ROOT_PASSWORD: root

dev:
depends_on:
- db
image: rapporteket/dev:nightly
volumes:
- .:/home/rstudio/rapbase/
- ~/.ssh:/home/rstudio/.ssh
- ~/.gitconfig:/home/rstudio/.gitconfig
ports:
- "8787:8787"
- "3838:3838"
dns:
- 8.8.8.8
restart: "no"
environment:
PASSWORD: password
DB_HOST: db
DB_USER: root
DB_PASS: root

adminer:
depends_on:
- db
image: adminer
restart: "no"
environment:
ADMINER_PLUGINS: frames
ports:
- 8888:8080