Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yassinedoghri/atlantiscms
Crisis Management System web app to monitor crisis situations in Singapore
https://github.com/yassinedoghri/atlantiscms
school-project symfony web-app
Last synced: 2 months ago
JSON representation
Crisis Management System web app to monitor crisis situations in Singapore
- Host: GitHub
- URL: https://github.com/yassinedoghri/atlantiscms
- Owner: yassinedoghri
- Created: 2017-02-24T02:33:29.000Z (almost 8 years ago)
- Default Branch: development
- Last Pushed: 2023-02-01T20:00:53.000Z (almost 2 years ago)
- Last Synced: 2024-10-15T01:05:25.612Z (3 months ago)
- Topics: school-project, symfony, web-app
- Language: JavaScript
- Size: 397 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AtlantisCMS
Atlantis CMS is a Crisis Management System web app to monitor crisis situations in Singapore.
## Table of contents
* [Getting Started](#getting-started)
* [User interface](#user-interface)
* [Versioning](#versioning)
* [Contributors](#contributors)
* [Copyright and licence](#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](http://www.wampserver.com/) (recommended)
- [XAMPP](https://www.apachefriends.org/fr/index.html)
- [EASYPHP](http://www.easyphp.org/)
- etc.
#### 2. Install [Git](https://git-scm.com/downloads)
- (Optional) Install [github desktop](https://desktop.github.com/)
#### 3. Clone the project to your computer
- **eg.** clone it to the `C:/wamp/www` folder
#### 4. Download and Install [Composer](https://getcomposer.org/download/):
- 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:
```sh
# 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](https://nodejs.org/en/) and [Bower](https://bower.io/#install-bower)
On the root or `static` folder of the project, you can now:
- Install Bower dependencies
```sh
# installs the project dependencies listed in bower.json
$ bower install
```
- Install npm dependencies (optional)
```sh
# 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:
```sh
$ php bin/console assets:install --symlink
```
#### 8. Run Symfony server
Go to the project root folder with the command line and execute:
```sh
$ php bin/console server:run
```
_**NB.** For 7 and 8, you might need to [add your PHP installation directory to the %PATH% environment variable](http://stackoverflow.com/a/7307581) 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](https://github.com/puikinsh/gentelella), an open source Bootstrap 3 Admin Template.
## Versioning
AtlantisCMS is maintained under the [Semantic Versioning guidelines](http://semver.org/).
## Contributors
This project is a school project for the CZ3003 module at the Nanyang Technological University (NTU) of Singapore.
### Student Team
- [Yassine Doghri](https://github.com/yassinedoghri)
- // ADD YOUR NAME
## Copyright and licence
// TO DO - Project licence.