Rallly is a free collaborative scheduling service that helps you and your friends vote on a date to host an event. The application has been developed with the MEAN stack of technologies.
Getting Started Quickly with Docker
This assumes that you have Docker installed
To get started quickly and easily, simply run the following:
git clone git@github.com:lukevella/Rallly.git
cd Rallly
Copy the sample .env
file then open it and set the variables.
cp sample.env .env
Now run the server!
docker-compose up -d
Now that was simple!
Detailed Production Docs
Manual SetupRequirements
To run Rallly you will need:
- MongoDB
- Node.js + npm
- Bower
Setup
Clone the repository on your machine and set the current directory to the root of the repository
git clone git@github.com:lukevella/Rallly.git
cd Rallly
Run the install script. This will install the node and bower dependencies and create a configuration file.
npm run installation
Manual Configuration
Only do this if you did not run npm run installation
Run the config script.
npm run installation -- -p
Open up config.json
and fill in the parameters.
{
"port": 3000,
"siteUrl": "http://localhost:3000", // Used for creating an absolute URL
"fromName": "Rallly", // Email from name
"fromEmail": "no-reploy@rallly.co", // Email from address
"db": "mongodb://localhost:27017/rallly", // MongoDB connection string
"smtpUser": "", // SMTP user name
"smtpPwd": "", // SMTP user password
"smtpHost": "", // SMTP host
"smtpPort": 587 // SMTP port
}
Running
To start the node server simply run npm start
.
Detailed Docs
DevelopmentIf you're going to be developing, run the watch
task with gulp. Gulp is used to build the CSS (with SASS), JS and templates.
gulp watch
npm start
License
See the LICENSE file.