Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kennedymwavu/mwavu
Personal Website
https://github.com/kennedymwavu/mwavu
ambiorix r
Last synced: 11 days ago
JSON representation
Personal Website
- Host: GitHub
- URL: https://github.com/kennedymwavu/mwavu
- Owner: kennedymwavu
- License: gpl-3.0
- Created: 2024-09-04T23:14:39.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T18:28:37.000Z (15 days ago)
- Last Synced: 2024-10-26T03:50:59.281Z (13 days ago)
- Topics: ambiorix, r
- Language: R
- Homepage: https://mwavu.com/
- Size: 3.04 MB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Personal Website
Made with ❤️ using Ambiorix
# Prerequisites
- R >= 4.1.0
# Installation
1. Clone the repo and `cd` into it:
```bash
[email protected]:kennedymwavu/mwavu.git
```
```bash
cd mwavu
```
1. Create an `env` file (`.Renviron`) at the root dir of the project and add this variable:
```r
RENV_CONFIG_SANDBOX_ENABLED = FALSE
```
1. Restore package dependencies:
```bash
R -e "renv::restore()"
```
The `-e` flag tells R to execute that expression and exit.
# Run app
```r
Rscript index.R
```
Then visit [localhost:8000](http://localhost:8000/) to view the app.
# Contact page messages
I have used [mailgun](https://www.mailgun.com/) to forward messages entered in
the contact page form to my email.
If you need the form to work you will have to:
1. Create a [mailgun account](https://www.mailgun.com/), add a sending domain,
and create an API key.
1. Add these variables to your `.Renviron`:
```r
MAILGUN_API_KEY = your-mailgun-api-key
MAILGUN_SENDING_DOMAIN = your-mailgun-sending-domain
EMAIL = your-personal-email
```
# Docker
- Build the docker image:
```bash
docker build -t personal-website .
```
- Run the services via docker compose:
```bash
docker compose up -d
```
This will run the app on port 1028 of the host machine, so you will view it
at [localhost:1028](http://localhost:1028/)
- To stop the services do:
```bash
docker compose down
```