README.md 2.54 KB
Newer Older
Anxhelo Lushka's avatar
Anxhelo Lushka committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# About

Briar is a messaging app designed for activists, journalists, and anyone else who needs a safe, easy and robust way to communicate. Unlike traditional messaging apps, Briar doesn't rely on a central server - messages are synchronized directly between the users' devices. If the internet's down, Briar can sync via Bluetooth or Wi-Fi, keeping the information flowing in a crisis. If the internet's up, Briar can sync via the Tor network, protecting users and their relationships from surveillance.

This guide aims to provide standards, principles and components to design consistent views related to the Briar Project. These pages are a living document and we welcome contributions, feedback and suggestions.


# Getting started

The Briar style guide is based on Bootstrap, an open-source toolkit for developing with HTML, CSS, and JS. We are currently on v4.1.0.

To use the Briar style guide, you can download our scss style (components.scss) and import it in your project with bootstrap included. SASS is a CSS extension language.

If you want to use SASS you can download the complete archive for the style guide. The scss folder under assets contains all the sass files. Since we use bootstrap, we only add a few styles without modifying bootstrap core or defining new elements whenever possible.

Bootstrap contains a few JavaScript libraries for extra interaction with the DOM. We use these libraries but do not add extra JavaScript, so that only few elements are affected if you disable JavaScript.

weru's avatar
weru committed
18 19 20
This styleguide has been built using Hugo. 

> Hugo is a fast and modern static site generator written in Go, and designed to make website creation fun again
weru's avatar
update  
weru committed
21

weru's avatar
weru committed
22
You can build this yourself by installing Hugo.
Anxhelo Lushka's avatar
Anxhelo Lushka committed
23 24 25

# Building

weru's avatar
weru committed
26
Before you can modify the contents, you need to have Hugo installed. Hugo extended is recommended when using sass. You can get the hugo installation file from [Hugo Releases](https://github.com/gohugoio/hugo/releases); choose one depending on your OS. If stuck, here is the [official hugo installation guide](https://gohugo.io/getting-started/installing/)
Anxhelo Lushka's avatar
Anxhelo Lushka committed
27

weru's avatar
weru committed
28
Once Hugo is installed and added to your PATH, you need to clone the repo on your system. You can do that by running the command.
Anxhelo Lushka's avatar
Anxhelo Lushka committed
29 30 31 32 33

`git clone $REPO`

Afterwards, execute the following command to build the project and to be able to browse it locally on your browser.

weru's avatar
weru committed
34
`hugo server`
Anxhelo Lushka's avatar
Anxhelo Lushka committed
35 36 37 38

That's it! Now you can begin to modify the files and they will be automatically built and displayed on your localhost upon a page refresh.

When you're done with the changes, press Ctrl+C to stop the localhost process.