Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rafaels88/pinfluence

All world's influence in a map. Ruby and Hanami open source project.
https://github.com/rafaels88/pinfluence

clean-architecture clean-code graphql hanami non-profit nonprofit opensource ruby

Last synced: 5 days ago
JSON representation

All world's influence in a map. Ruby and Hanami open source project.

Host: GitHub
URL: https://github.com/rafaels88/pinfluence
Owner: rafaels88
License: mit
Created: 2016-06-07T22:46:08.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2018-08-25T12:35:11.000Z (about 6 years ago)
Last Synced: 2024-05-18T21:41:30.863Z (6 months ago)
Topics: clean-architecture, clean-code, graphql, hanami, non-profit, nonprofit, opensource, ruby
Language: Ruby
Homepage: http://pinfluence.org
Size: 618 KB
Stars: 26
Watchers: 6
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code-of-conduct.md

Awesome Lists containing this project

awesome-starred - rafaels88/pinfluence - All world's influence in a map. Ruby and Hanami open source project. (ruby)

README

# Pinfluence

[![Build Status](https://travis-ci.org/rafaels88/pinfluence.svg?branch=master)](https://travis-ci.org/rafaels88/pinfluence)
[![Code Climate](https://codeclimate.com/github/rafaels88/pinfluence.png)](https://codeclimate.com/github/rafaels88/pinfluence)

[http://pinfluence.org ](http://pinfluence.org) - All world's influence in a map. Non-profit open source project.

This is an open source project for a study purpose in order to develop a real application
using mainly Ruby and Hanami, and other technologies which could fit well, like GraphQL.

You can use it as a reference for building your own project, and of course, you are welcome
to contribute on this one as well.

## Requirements

- Ruby (>= 2.4.1)
- Postgresql (>= 9.3)
- QT (== 5.5) [Installation instructions](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit)
- Bundler

## Quick start

1. Make a copy of `.env.development.example` to `.env.development`;
1. Open `.env.development` and `.env.test` files and configure the `DATABASE_URL` with your local database informations

This is a Ruby project, so it is nice to have [RVM](https://rvm.io/) or [Rbenv](https://github.com/rbenv/rbenv) installed.

```bash
$ gem install bundler
$ bundle # install all gems
```

After, you need to setup your database.

```bash
$ bundle exec hanami db prepare
```

Now, run the server:

```bash
$ bundle exec hanami server
```

Website will be available in [http://localhost:2300](http://localhost:2300)

## Development

The project has three apps:

- WEB (`/`), which has all code to show public information, like Map;
- API (`/api`), is a public GraphQL API which `web` app makes use;
- ADMIN (`/admin`), is the dashboard. This is a restrict area.

When you run the server you run all these apps.

### Creating admin user

To create an access to admin, just create an user using `hanami console`:

```bash
$ bundle exec hanami console

CreateUser.call name: "Your Name", email: "[email protected]", password: "your-plain-password"
```

And done. You now have access to local admin area.

### Testing

1. Since this project is using `capybara-webkit`, make sure you have all dependencies installed. [Click here for instructions](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit#instructions-for-installing)

1. You need to prepare your test database

```bash
$ HANAMI_ENV=test bundle exec hanami db prepare
```

Now, run the tests. If everything is fine, all tests are going to pass.

```bash
$ bundle exec rspec
```

A `Guardfile` is also available if you want to `bundle exec guard`.

## Deployment

```bash
$ cap production deploy
```

## Contributing

Before it, see the [code of conduct](https://github.com/rafaels88/pinfluence/blob/master/code-of-conduct.md).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## License