Skip to content

Commit 6a56c1a

Browse files
authored
Update README.md
1 parent 7ba0885 commit 6a56c1a

File tree

1 file changed

+24
-57
lines changed

1 file changed

+24
-57
lines changed

README.md

+24-57
Original file line numberDiff line numberDiff line change
@@ -3,68 +3,32 @@
33

44
This is the repository for Cafe Variome in CodeIgniter 4.
55

6-
For documentation, please go to https://www.cafevariome.org/
7-
6+
For an overview of Cafe Variome, please go to https://www.cafevariome.org/
87

9-
## Installation
10-
---
11-
### Cloning the repositories:
12-
13-
$ `git clone https://github.com/CafeVariomeUoL/CafeVariomeCI4.git`
14-
15-
### Changing Owner ship and renaming directories:
16-
17-
$ `mv CafeVariomeCI4/ your_desired_directory/`
18-
$ `sudo chown $USER:$USER your_desired_directory -R`
19-
20-
### Creating the database:
21-
22-
$ `mysql -u [username] -p`
23-
$ `CREATE DATABASE cafevariome;`
8+
For documentation, please visit https://cafe-variome.gitbook.io/cafe-variome-docs/
249

25-
### Setting the permission for the writable folder of CodeIgniter:
26-
27-
Set the permission within the root directory of Cafe Variome:
28-
Checking the corresponding user within the Linux distribution with the following command:
29-
30-
$ `ps aux | egrep '(apache|httpd)'`
31-
32-
On Ubuntu the Apache user is _www-data_.
33-
34-
$ `setfacl -m u:www-data:rwx -R writable/ writable/logs writable/session/ writable/cache/`
10+
## Getting started
11+
#### Detailed instructions available [here](https://cafe-variome.gitbook.io/cafe-variome-docs/how-to-install-it/).
12+
---
13+
### Checklist:
14+
- [ ] Satisfy [system requirements]()
15+
- [ ] Create database
16+
- [ ] Configure .env
17+
- [ ] Install dependencies
18+
- [ ] Install Cafe Variome
3519

36-
### Editing configurations in App.php and Database.php
20+
### Cloning the repository:
3721

38-
The base URL needs to be set in the system using the following commands:
22+
$ `git clone https://github.com/Cafe-Variome/CafeVariome.git`
3923

40-
$ `vim app/Config/App.php`
41-
public $baseURL=’<URL_TO_ACCESS_CAFEVARIOME>’;
24+
### Changing Ownership and renaming directories:
4225

43-
Similarly, the database credentials need to be set using the following commands:
26+
$ `mv CafeVariome/ your_webserver_directory/`
27+
$ `sudo chown $USER:$USER your_webserver_directory -R`
4428

45-
$ `vim app/Config/Database.php`
29+
### Editing configuration in env template:
4630

47-
> public $default = [
48-
> 'DSN' => '',
49-
> 'hostname' => 'localhost',
50-
> 'username' => 'root',
51-
> 'password' => 'Your Password',
52-
> 'database' => 'cafevariome',
53-
> 'DBDriver' => 'MySQLi',
54-
> 'DBPrefix' => '',
55-
> 'pConnect' => false,
56-
> 'DBDebug' => (ENVIRONMENT !== 'production'),
57-
> 'cacheOn' => false,
58-
> 'cacheDir' => '',
59-
> 'charset' => 'utf8',
60-
> 'DBCollat' => 'utf8_general_ci',
61-
> 'swapPre' => '',
62-
> 'encrypt' => false,
63-
> 'compress' => false,
64-
> 'strictOn' => false,
65-
> 'failover' => [],
66-
> 'port' => 3306,
67-
> ];
31+
Cafe Variome comes packaged with an [env](env) template. All you have to do is add server URL and database details in the relevant fields of the template as [shown here](https://cafe-variome.gitbook.io/cafe-variome-docs/how-to-install-it/installing-cafe-variome#configuring-env-template).
6832

6933
### Installing dependencies through Composer:
7034

@@ -74,9 +38,12 @@ $ `composer install`
7438

7539
### Importing Cafe Variome Database and setting permissions through Composer
7640

77-
In the root directory of Cafe Variome where composer.json resides run the following command:
41+
In the root directory of Cafe Variome where composer.json resides, run the following command:
7842

7943
$ `composer CVInstall`
8044

81-
At this step you will be prompted to enter your installation key which has been given to you prior to installing the software.
82-
Also, you will need to enter the URL to the Cafe Variome Net service you wish to use. Please note that you need to point Cafe Variome to that Cafe Variome Net instance which has issues your installation key.
45+
At this step you will be prompted to enter your installation key which has been given to you prior to installing the software.
46+
Also, you will need to enter the URL to the Cafe Variome Net server you wish to use. Please note that you need to point Cafe Variome to that Cafe Variome Net instance which has issued your installation key.
47+
48+
### Further Steps
49+
Configuring the software and the process of making your data discoverable is described in detail [here](https://cafe-variome.gitbook.io/cafe-variome-docs/how-to-install-it/quick-start).

0 commit comments

Comments
 (0)