diff --git a/README.md b/README.md index 709ee907a..1cc2ab713 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,27 @@ On the Settings tab, admins can easily control their event application timeline ### Quick deploy with Heroku [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) +### Requirements +| Requirement | Version | +| ------------------------------------------- | ------- | +| [GCC 4.6](https://gcc.gnu.org) | `4.6+` | +| [Node.js](http://nodejs.org) | `8.0+` | +| [MongoDB](www.mongodb.com/) | `3.0+` | + +> _Updating to the latest releases is recommended_. + +Run the following commands to check the current installed versions: + +```shell +gcc --version +node -v +mongo --version +``` +How to upgrade to latest releases: +- GCC: https://wiki.gentoo.org/wiki/Upgrading_GCC +- Node.js: https://nodejs.org/en/download/ +- MongoDB: https://docs.mongodb.com/manual/administration/install-community/ + ### Deploying locally Getting a local instance of Quill up and running takes less than 5 minutes! Start by setting up the database. Ideally, you should run MongoDB as a daemon with a secure configuration (with most linux distributions, you should be able to install it with your package manager, and it'll be set up as a daemon). Although not recommended for production, when running locally for development, you could do it like this