Skip to content

Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.

Self hosting repo (#394)

Luke Vellae5ebf87390ef
diff --git a/README.md b/README.md
index 968b56c68..932642b75 100644
--- a/README.md
+++ b/README.md
@@ -6,38 +6,17 @@
![hero](./docs/images/hero-image.png)
-Self-hostable doodle poll alternative. Find the best date for a meeting with your colleagues or friends without the back and forth emails.
+Schedule group meetings with friends, colleagues and teams. Create meeting polls to find the best date and time to organize an event based on your participants' availability. Save time and avoid back-and-forth emails.
Built with [Next.js](https://github.com/vercel/next.js/), [Prisma](https://github.com/prisma/prisma), [tRPC](https://github.com/trpc/trpc) & [TailwindCSS](https://github.com/tailwindlabs/tailwindcss)
-## ๐Ÿณ Quickstart with docker
+## Self-hosting
-_For running in a production environment_
+Check out the [self-hosting repo](https://github.com/lukevella/rallly-selfhosted) for more information on running your own instance of Rallly.
-Clone this repo and change directory to the root of the repository.
-
-```bash
-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.
-
-```bash
-cp sample.env .env
-```
-
-_See [configuration](#%EF%B8%8F-configuration) to see what parameters are availble._
-
-Build and run with `docker-compose`
-
-```bash
-docker-compose up -d
-```
-
-Go to [http://localhost:3000](http://localhost:3000)
+_[2023-01-12]: The docker configuration for self-hosters previously stored in this repo has been moved to the self-hosting repo mentioned above. Please switch to that repo if you are self-hosting._
-## ๐Ÿ’ป Running locally
+## Running locally
Clone this repo and change directory to the root of the repository.
@@ -52,7 +31,7 @@ Copy the sample `.env` file then open it and set the variables.
cp sample.env .env
```
-_See [configuration](#%EF%B8%8F-configuration) to see what parameters are availble._
+_See [configuration](#configuration) to see what parameters are availble._
Install dependencies
@@ -60,7 +39,7 @@ Install dependencies
yarn
```
-Next we need to run the database migrations to create our tables
+Next, run the database migrations to create our schema
```
yarn prisma migrate deploy
@@ -76,7 +55,7 @@ yarn build
yarn start
```
-## โš™๏ธ Configuration
+## Configuration
| Parameter | Default | Description |
| -------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
@@ -90,19 +69,19 @@ yarn start
| SMTP_USER | - | Username to use for your SMTP connection |
| SMTP_PWD | - | Password to use for your SMTP connection |
-## ๐Ÿ‘จโ€๐Ÿ’ป Contributors
+## Contributors
If you would like to contribute to the development of the project please reach out first before spending significant time on it.
### Translators ๐Ÿ‡ซ๐Ÿ‡ท ๐Ÿ‡ฉ๐Ÿ‡ช ๐Ÿ‡ฎ๐Ÿ‡น ๐Ÿ‡ช๐Ÿ‡ธ
-If you'd like to volunteer to translate Rallly to another language, check out our [guide for translators](https://github.com/lukevella/rallly/wiki/Guide-for-translators).
+You can help translate Rallly to another language our [guide for translators](https://github.com/lukevella/rallly/wiki/Guide-for-translators).
-## ๐Ÿ‘ฎโ€โ™‚๏ธ License
+## License
Rallly is open-source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version. See [LICENSE](LICENSE) for more detail.
-## ๐Ÿ™ Sponsors
+## Sponsors
Big thanks to these folks for sponsoring the project!
diff --git a/docker-compose.local.yml b/docker-compose.local.yml
deleted file mode 100644
index 2cbc84226..000000000
--- a/docker-compose.local.yml
+++ /dev/null
@@ -1,5 +0,0 @@
-# Build and run the project locally
-services:
- rallly:
- build:
- context: .
diff --git a/docker-compose.yml b/docker-compose.yml
index fb4320319..b5e6239af 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -14,7 +14,8 @@ services:
retries: 5
rallly:
- image: lukevella/rallly:latest
+ build:
+ context: .
restart: always
depends_on:
rallly_db: