moretoend / hack2save Goto Github PK

View Code? Open in Web Editor NEW

12.0 9.0 9.0 138 KB

Project Hack2Save

Ruby 75.46% JavaScript 1.32% CSS 0.96% HTML 22.18% Shell 0.08%

volunteers volunteering ruby ruby-on-rails non-profit-organizations

hack2save's Introduction

README

An APP about Volunteering

Our main goal is to build a place for Volunteering.

It'll be an webapp where institutions (nonprofit organizations) can add jobs and volunteers can subscribe to its jobs. Not only manage this subscriptions, we want to make a clear environment for both sides know better who wants to work and with which kind of company a people will work.

We are an open source project.

So, WELCOME!

Our technilogies

Rails
Redis
Docker
Mailcatcher
Postgresql

First setup for running

At first, you need to setup some configurations after clonning the repo to your local machine.

Create your own database.yml

On the repo we have a file database-sample.yml on config dir. It's an sample to create your own. Please, don't delete it.

Setup in your machine

As we use docker, we have a docker-compose.yml for it.

If you want to use, your first step must be create your database.yml with the following content

default: &default
 adapter: postgresql
 encoding: unicode
 pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
 host: postgres
 user: postgres

development:
  <<: *default
  database: hack2save_development 

test:
  <<: *default
  database: hack2save_test

After creating this file, run the following commands:

1. docker-compose build
2. docker-compose run --rm website bundle install
3. docker-compose run --rm website bundle exec rails db:create
4. docker-compose run --rm website bundle exec rails db:migrate
5. docker-compose up

hack2save's People

Contributors

Stargazers

Watchers

Forkers

lairtonmendes rafaelbadan marcusvfmleite eduardotecnologo rafael-acerqueira saulomendonca enchenu danilocandido codetriage-readme-bot

hack2save's Issues

Registration error

When I try to registrate myself clicking on Sign up link, an error saying constant Registration doesn't exists is returned to me.

Institution scope select

Change Insitution select on top bar to fill it with institutions added o app and change institution scope after select one

Create all models

Create all models of project based on model at Wiki

Create controller of institutions

Create a controller for institutions with actions that enable a CRUD operation. For now, a institution must have a name, a description and its category.

Create the master template for app

Create a master view that will be used on app. The mater template must have a menu, a search field and a aside bar.

There is a mockup for this page on the link:
https://wireframepro.mockflow.com/view/D635fff1239e8f36e9e526246d4a2e117

Controller to manage jobs

A controller to manage CRUD operations on a given job must be created.
For creating a job it's needed a title, description, requirements, start date and end date of it.

A job have a high dependency of an Institution.

Create views for subscribe to a job

Create a view the user will use to do its subscription for a given job. On this view, the user must sent a cover letter.

Create wireframes

Design Wireframes using materialize in: wireframepro.mockflow.com

Create views for intitutions

Create views for add, edit, show and list institutions

Create controller for permissions

Create a controller that enables to set permissions to an institution. On creating, the profile of the user on that institution must be past.
For now, the user profiles must be :owner, :administrator or :approver.

Controller for subscriptions

A controller to manage subscriptions must be created. It must enables creation and updating of a given subscription.
A subscription has a high dependency of a job and o creation, a cover letter must be sent by the user that is subscribing for a given job.
After creating, the user subscribed can't update it anymore. Only the users with right permissions on institution can update its status.