README.md 1.39 KB
Newer Older
Julien Fastré's avatar
Julien Fastré committed
1
# chill.social
Julien Fastré's avatar
Julien Fastré committed
2 3

The content of the website [http://chill.social](http://chill.social).
4 5 6 7 8 9 10 11 12

## folder

`_drafts` contains notes and differents things to prepare the website. It should not be published.

`website` contains the website. This part should be published.

## installation

Julien Fastré's avatar
Julien Fastré committed
13 14
You must have `npm` and `bower` installed.

15 16
```bash
git clone git@github.com:Chill-project/chill.social
17
cd chill.social
Julien Fastré's avatar
Julien Fastré committed
18 19 20
npm install
grunt install
```
21 22

#open in your browser:
Julien Fastré's avatar
Julien Fastré committed
23 24

```
25 26 27 28 29
firefox /path/to/repo/chill.social/website/index.html
```

The main page is website/index.html

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
## deploy

A task `grunt deploy` will deploy on server running the website `http://chill.social`. This task will run the install task and, then, upload files to remote server.

Before running this command, you must :

- have access on the server :-)
- configure a .ftppass at the root of the project. A basic .ftppass will be : 

```json
{
  "chill.social": {
     "username": "root",
     "agent": true
  }
}

```

For complete configuration, see https://www.npmjs.com/package/grunt-sftp-deploy

Julien Fastré's avatar
Julien Fastré committed
51 52 53 54 55 56 57
## Contribute

Things to know :

- the task `grunt install` will install bower dependencies and minify js ;
- the task `grunt` will minify js and bootlint-check htm files.

58

Julien Fastré's avatar
Julien Fastré committed
59

60 61 62 63 64 65
### less files

The bootstrap framework is used, but unused parts are removed, and some are overriden.

In directory `src/less` you will find personalized components using bootstrap mixins.