installation.md 1.83 KB
Newer Older
Sebastian Castro's avatar
Sebastian Castro committed
1 2 3
Installation and Production Instructions
========================================

Alan Poulain's avatar
Alan Poulain committed
4
Feel free to add some more information if you solve installation issues!
5

Alan Poulain's avatar
Alan Poulain committed
6
Quick Install
Sebastien Rosset's avatar
Sebastien Rosset committed
7 8
-------------

Alan Poulain's avatar
Alan Poulain committed
9
- **Debian script**: there is a script for Debian installation named `install_debian.sh` in this docs directory! After installation, go to `http://localhost/GoGoCarto/web/project/initialize` to initialize your project.
Sebastien Rosset's avatar
Sebastien Rosset committed
10 11

- **Docker containers**: please follow the instructions [here](installation_docker.md).
Sebastian Castro's avatar
Sebastian Castro committed
12

13
Manual Install: Requirements
Sebastian Castro's avatar
Sebastian Castro committed
14 15
------------

Alan Poulain's avatar
Alan Poulain committed
16
1. PHP 7
17
2. [Composer](https://getcomposer.org/download/)
Sebastian Castro's avatar
Sebastian Castro committed
18 19
3. [Nodejs](https://nodejs.org/en/download/)
4. [Git](https://git-scm.com/)
Alan Poulain's avatar
Alan Poulain committed
20
5. Web Server (Apache, Nginx, [Wamp server](http://www.wampserver.com/) ...)
21
6. MongoDB (http://php.net/manual/fr/mongodb.installation.php) -> !!Version 3.4 or below!!!
Sebastian Castro's avatar
Sebastian Castro committed
22

Sebastien Rosset's avatar
Sebastien Rosset committed
23 24
Consider the [Docker installation](installation_docker.md) if you run into troubles installing these softwares.

Sebastian Castro's avatar
Sebastian Castro committed
25 26 27
Installation
------------

28
### Cloning Repository
Alan Poulain's avatar
Alan Poulain committed
29 30

```shell
Sebastian Castro's avatar
Sebastian Castro committed
31
git clone https://gitlab.adullact.net/pixelhumain/GoGoCarto.git
Sebastian Castro's avatar
Sebastian Castro committed
32 33
```

34
### Initialize the Project
Alan Poulain's avatar
Alan Poulain committed
35 36 37

Create an `.env.local` file containing:

Sebastian Castro's avatar
Sebastian Castro committed
38
```
Alan Poulain's avatar
Alan Poulain committed
39
MONGODB_URL=mongodb://localhost:27017
Sebastian Castro's avatar
Sebastian Castro committed
40 41
```

42
Execute the command:
Alan Poulain's avatar
Alan Poulain committed
43 44

```shell
45
make init
Sebastian Castro's avatar
Sebastian Castro committed
46 47
```

48 49 50 51
It will:
- install the dependencies
- install and build the assets
- load the fixtures
Alan Poulain's avatar
Alan Poulain committed
52

53
Now initialize your project with the following route:
Alan Poulain's avatar
Alan Poulain committed
54

55
`http://localhost/GoGoCarto/web/project/initialize`
Sebastian Castro's avatar
Sebastian Castro committed
56

57 58
Start
-----
Alan Poulain's avatar
Alan Poulain committed
59

60
Start watching for file changes (automatic recompilation):
Sebastian Castro's avatar
Sebastian Castro committed
61

Alan Poulain's avatar
Alan Poulain committed
62
```shell
63
gulp watch
Alan Poulain's avatar
Alan Poulain committed
64 65
```

66
Updating your Production Install
Sebastian Castro's avatar
Sebastian Castro committed
67 68
---------------------

69
Each time you want to update GoGoCarto, run:
Alan Poulain's avatar
Alan Poulain committed
70 71

```shell
72
make gogo-update
Sebastian Castro's avatar
Sebastian Castro committed
73
```
74

Alan Poulain's avatar
Alan Poulain committed
75
You can have a look to [the CHANGELOG](../CHANGELOG.md) to know what are the new features.
Sebastian Castro's avatar
Sebastian Castro committed
76

77 78

Issues
79
------
80

Alan Poulain's avatar
Alan Poulain committed
81 82 83
If memory limits while using Composer:

```shell
84
COMPOSER_MEMORY_LIMIT=-1 composer ...
Alan Poulain's avatar
Alan Poulain committed
85
```