3pp-mirror/rallly
1
0
Fork 0
mirror of https://github.com/lukevella/rallly.git synced 2025-05-04 04:36:04 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Luke Vella 2022-04-13 16:38:43 +01:00
parent cc7a00dff8
commit ddc370ac25
3 changed files with 33 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View file

@ -1,4 +1,4 @@
name: ci name: CI
on: pull_request on: pull_request
jobs: jobs:

46
README.md
View file

@ -1,6 +1,6 @@
<img src="./public/logo.png" width="200" /> <img src="./public/logo.png" width="200" />
[![Actions Status](https://github.com/lukevella/rallly/workflows/ci/badge.svg)](https://github.com/lukevella/rallly/actions) [![Actions Status](https://github.com/lukevella/rallly/workflows/CI/badge.svg)](https://github.com/lukevella/rallly/actions)
Rallly is an open-source collaborative scheduling service – designed and developed by @lukevella Rallly is an open-source collaborative scheduling service – designed and developed by @lukevella
@ -19,18 +19,17 @@ git clone https://github.com/lukevella/Rallly.git
cd Rallly cd Rallly
``` ```
_optional_: Configure your SMTP server. Without this, Rallly won't be able to send out emails. You can set the following environment variables in a `.env` in the root of the project. _optional_: Configure your SMTP server. Without this, Rallly won't be able to send out emails. You can set the following environment variables in a `.env` in the root of the project
``` ```
# /.env # support email - used as FROM email by SMTP server
# This will appear as the FROM email address SUPPORT_EMAIL=foo@yourdomain.com
SUPPORT_EMAIL="" # SMTP server - required if you want to send emails
# SMTP Server Details SMTP_HOST=your-smtp-server
SMTP_HOST="" SMTP_PORT=587
SMTP_PORT="" SMTP_SECURE="false"
SMTP_SECURE="" # Enable TLS - "true" or "false" (default: "false") SMTP_USER=your-smtp-user
SMTP_USER="" SMTP_PWD=your-smtp-password
SMTP_PWD=""
``` ```
Build and run with `docker-compose` Build and run with `docker-compose`
@ -53,23 +52,22 @@ cd Rallly
Copy the sample `.env` file then open it and set the variables. Copy the sample `.env` file then open it and set the variables.
```bash ```bash
cp rallly-conf.env .env cp sample.env .env
``` ```
You will need to supply a url to an empty postgres database. Fill in the required environment variables.
``` ```
# /.env # postgres database - not needed if running with docker-compose
# Postgres connection URL DATABASE_URL=postgres://your-database/db
DATABASE_URL="" # support email - used as FROM email by SMTP server
# This will appear as the FROM email address SUPPORT_EMAIL=foo@yourdomain.com
SUPPORT_EMAIL="" # SMTP server - required if you want to send emails
# SMTP Server Details SMTP_HOST=your-smtp-server
SMTP_HOST="" SMTP_PORT=587
SMTP_PORT="" SMTP_SECURE="false"
SMTP_SECURE="" # Enable TLS - "true" or "false" (default: "false") SMTP_USER=your-smtp-user
SMTP_USER="" SMTP_PWD=your-smtp-password
SMTP_PWD=""
``` ```
Install dependencies Install dependencies

18
sample.env
View file

@ -1,8 +1,10 @@
# postgres database - not needed if running with docker-compose # postgres database - not needed if running with docker-compose
DATABASE_URL=replace-me DATABASE_URL=postgres://your-database/db
# smtp server - required if you want to receive emails # support email - used as FROM email by SMTP server
SMTP_HOST=replace-me SUPPORT_EMAIL=foo@yourdomain.com
SMTP_PORT=replace-me # SMTP server - required if you want to send emails
SMTP_SECURE=replace-me # TLS Enabled - "true" or "false" (default: "false") SMTP_HOST=your-smtp-server
SMTP_USER=replace-me SMTP_PORT=587
SMTP_PWD=replace-me SMTP_SECURE="false"
SMTP_USER=your-smtp-user
SMTP_PWD=your-smtp-password