AtlantisCMS

AtlantisCMS

Atlantis CMS is a Crisis Management System web app to monitor crisis situations in Singapore.

Table of contents

• Getting Started
• User interface
• Versioning
• Contributors
• Copyright and licence

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development purposes.

1. Download and Install a web server software bundle:

Choose one of these:

• WAMP (recommended)
• XAMPP
• EASYPHP
• etc.

2. Install Git

• (Optional) Install github desktop

3. Clone the project to your computer

• eg. clone it to the C:/wamp/www folder

4. Download and Install Composer:

• Specify the path to the PHP executable which was installed with the first step
• After installation, use the command line, go to the root of the project and run:

# install php-xml, resolves XmlUtils.php:52 problem
$ apt install php-xml
# installs the project dependencies listed in composer.json
$ composer update

NB. A prompt will ask you to input the project parameters to create the /app/config/parameters.yml file. Enter the relevant parameters or leave it to default values.

5. Install NodeJS and Bower

On the root or static folder of the project, you can now:

• Install Bower dependencies

# installs the project dependencies listed in bower.json
$ bower install

• Install npm dependencies (optional)

# installs the project dependencies listed in package.json
$ npm install

6. Import database structure & data

Go to phpmyadmin and import the structure & data files of the atlantis_cms database.

NB. You'll find the .sql files on Google drive (database folder).

7. Install project assets

Go to the project root folder with the command line and execute:

 $ php bin/console assets:install --symlink

8. Run Symfony server

Go to the project root folder with the command line and execute:

 $ php bin/console server:run

NB. For 7 and 8, you might need to add your PHP installation directory to the %PATH% environment variable beforehand.

The server should be running on the default address: http://127.0.0.1:8000

User interface

The UI of Atlantis CMS is based on gentelella, an open source Bootstrap 3 Admin Template.

Versioning

AtlantisCMS is maintained under the Semantic Versioning guidelines.

Contributors

This project is a school project for the CZ3003 module at the Nanyang Technological University (NTU) of Singapore.

Student Team

• Yassine Doghri
• // ADD YOUR NAME

Copyright and licence

// TO DO - Project licence.