rallly/README.md
2022-05-09 17:29:16 +01:00

4.6 KiB
Raw Blame History

Actions Status License: AGPL v3 Donate

hero

Rallly is a free group meeting scheduling tool built with Next.js, Prisma & TailwindCSS

🐳 Quickstart with docker

For running in a production environment

Clone this repo and change directory to the root of the repository.

git clone https://github.com/lukevella/rallly.git
cd rallly

Once inside the directory create a .env file where you can set your environment variables. There is a sample.env that you can use as a reference.

cp sample.env .env

See configuration to see what parameters are availble.

Build and run with docker-compose

docker-compose up -d

Go to http://localhost:3000

💻 Running locally

Clone this repo and change directory to the root of the repository.

git clone https://github.com/lukevella/rallly.git
cd rallly

Copy the sample .env file then open it and set the variables.

cp sample.env .env

See configuration to see what parameters are availble.

Install dependencies

yarn

Next we need to run the database migrations to create our tables

yarn prisma migrate deploy

Start the Next.js server

# For development
yarn dev
# For production
yarn build
yarn start

⚙️ Configuration

Parameter Default Description
DATABASE_URL postgres://postgres:postgres@rallly_db:5432/db A postgres database URL. Leave out if using the docker-compose file since it will spin up and connect to its own database instance.
SECRET_PASSWORD - A long string (minimum 25 characters) that is used to encrypt session data.
SUPPORT_EMAIL - An email address that will appear as the FROM email for all emails being sent out.
SMTP_HOST - Host name of your SMTP server
SMTP_PORT - Port of your SMTP server
SMTP_SECURE false Set to "true" if SSL is enabled for your SMTP connection
SMTP_USER - Username to use for your SMTP connection
SMTP_PWD - Password to use for your SMTP connection

👨‍💻 Contributors

If you would like to contribute to the development of the project please reach out first before spending significant time on it.

👮‍♂️ License

Rallly is open-source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version. See LICENSE for more detail.

🙏 Sponsors

These companies have graciously offered their services in support of this project.

Powered by Vercel     Sentry     Sentry