nprail/rallly repository overview

⁠Update: 11 Nov 2016 📝

Hey guys, thanks for all your feedback and your interest in Rallly! I'm currently working on a new version that will address all the issues being brought up in this project along with a visual refresh and an up to date technology stack. I'm really excited to bring you this new and improved Rallly and hope to see even more people using it in the future. – Luke

⁠Rallly⁠

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 [email protected]: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!

⁠Manual Setup Detailed Production Docs⁠

⁠Requirements

To run Rallly you will need:

• MongoDB
• Node.js + npm
• Bower (Not Necessary)

⁠Setup

Clone the repository on your machine and set the current directory to the root of the repository

git clone [email protected]: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": "[email protected]", // Email from address
    "dbName": "rallly", // MongoDB database name
    "dbAddress": "localhost", // MongoDB address not including port. 
    "dbUser": "", // MongoDB user name - leave blank if MongoDB auth is disabled
    "dbPwd": "", // MongoDB user password - leave blank if MongoDB auth is disabled
    "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.

⁠Development Detailed Docs⁠

If 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 for license rights and limitations (CC-BY-NC)