improve installation/documentation
This commit is contained in:
61
README.md
61
README.md
@@ -1,14 +1,54 @@
|
||||
## gancio
|
||||
### shared agenda for local communities
|
||||
# gancio
|
||||
#### a shared agenda for local communities
|
||||
|
||||
> :warning: Gancio is under heavy development,
|
||||
> if something is not working as expected, it's expected :D
|
||||
> :warning: WARNING :warning:
|
||||
> Gancio is under heavy development, if something is not working as expected, it's expected :D
|
||||
Please be patient and open an [issue](/cisti/gancio/issues)!
|
||||
|
||||
|
||||
|
||||
## Install
|
||||
You will need `npm` or `yarn` installed in your system.
|
||||
## Installation
|
||||
|
||||
##### Install node
|
||||
```bash
|
||||
# source https://github.com/nodesource/distributions/blob/master/README.md
|
||||
curl -sL https://deb.nodesource.com/setup_12.x | bash -
|
||||
apt-get install -y nodejs
|
||||
```
|
||||
|
||||
##### Install postgres
|
||||
```bash
|
||||
apt install postgresql
|
||||
```
|
||||
##### Create database
|
||||
```bash
|
||||
sudo -u postgres psql
|
||||
postgres=# create database gancio;
|
||||
postgres=# create user gancio with encrypted password 'gancio';
|
||||
postgres=# grant all privileges on database gancio to gancio;
|
||||
```
|
||||
##### Install gancio
|
||||
```bash
|
||||
npm install --global gancio
|
||||
```
|
||||
|
||||
##### Create a new user
|
||||
```bash
|
||||
adduser gancio
|
||||
su gancio
|
||||
```
|
||||
|
||||
##### Setup & test
|
||||
```bash
|
||||
gancio --help
|
||||
gancio setup
|
||||
gancio start
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### Hacking
|
||||
|
||||
``` bash
|
||||
# clone this repo
|
||||
@@ -18,18 +58,9 @@ cd gancio
|
||||
# install dependencies
|
||||
yarn install
|
||||
|
||||
# edit configuration
|
||||
cp config.example.js config.js
|
||||
|
||||
# - migrate/create test sqlite db
|
||||
yarn migrate:dev
|
||||
|
||||
# testing with sqlite db
|
||||
yarn dev
|
||||
|
||||
# - migrate/create production db
|
||||
yarn migrate
|
||||
|
||||
# build for production and launch server
|
||||
yarn build
|
||||
yarn start
|
||||
|
||||
Reference in New Issue
Block a user