yogodoshi/cansei

Tá de saco cheio de uma empresa pelo seu péssimo atendimento ao consumidor? Junte-se a outros e lembre-os incessantemente de quão insatisfeito vocês estão!

cansei's Issues

Remove the `test` folder

Since the project is using RSpec I think we can remove this.

Set code of conduct

https://opensource.guide/code-of-conduct/

Version 2.0: making companies better all around the world

Description

Change everything to english so anyone in the world can use it. Also make almost every text on it configurable so people can use this project to complain to a Thai company if they deserve it 👍

To-do

• are we gonna keep localization files to make it even easier to people set up their website in any language?
• make sure the README is in english (keep the pt-br version as README-pt and link it in the english version)
• translate github's project description to english
• Q&A the whole process in a different language

Enable people to deploy to heroku easily through the command-line

Mauro suggested that we looked into how pah (https://github.com/Helabs/pah/tree/master/lib/pah/templates) works and maybe try to do the same.

Set Hound up

https://houndci.com/

Choose an open source license

https://help.github.com/articles/open-source-licensing/#where-does-the-license-live-on-my-repository

Set contribution guidelines

https://help.github.com/articles/setting-guidelines-for-repository-contributors/

Allow a custom domain name to be configured

Allow the user to easily set a custom domain.

To-do

• implement it
• make it configurable through the settings vars
• add ENV var as canonical host
• explain how in the tutorial

Things to double-check before releasing first version

• The issue queue is up-to-date, with issues clearly organized and labeled
• Project uses consistent code conventions and clear function/method/variable names
• The code is clearly commented, documenting intentions and edge cases
• 100% spec coverage
• define how we will work with branches
• README is written in portuguese

Project setup

Rails setup.

Improve SEO

Improve:

• meta tags
• title
• semantic html

Version 0.1: make it work as intended

Description

The 0.1 version will be a "just works™" version. It won't allow any configuration at all.

To-do

• Implement User model (validations, specs, etc)
• setup omniauth/ omniauth-twitter (gem, action, routes, helpers, etc)
• Implement log-out (route, action, specs)
• Implement Users#new (which will be the unlogged in page, there is no #create as the user will be created through omniauth)
• Implement Users#edit (when the user is logged in)
• Implement Users#update (to update the tweet preference)
• Implement TwitterService#tweet_to_the_company with hardcoded texts, messages, company, etc
• Implement rake task that calls TwitterService#tweet_to_the_company for each User
  • create a rake task for each frequency and set it up accordingly on heroku so the user tweets at the intended frequency
• handle the scenario where the user doesnt authorize the twitter log-in
• Q&A back-end
• Deploy

Set Travis up

https://travis-ci.org/

To-do

• setup
• add build status image to the README
• check the README after the branch gets merged in

Design and add favicon

Check other open source projects to see if we forgot anything important

Suggested by @maurogeorge:

• https://github.com/maurogeorge/conf_boilerplate_ruby
• https://github.com/braziljs/conf-boilerplate
• https://github.com/call4paperz/call4paperz
• https://github.com/catarse/catarse
• https://github.com/discourse/discourse
• https://github.com/eurucamp/call4papers

Set hakiri up

https://hakiri.io/

I never used this service, I saw some projects using.

Set coveralls up

https://coveralls.io

Version 1.0: working beautifully

Description

Besides working as intended, it will do so beautifully with Nick's help 😍

Add a counter for how many tweets the app has sent

I think it helps build trust in the app 👍

Users should be able to disconnect their Twitter account

• Users should be able to disconnect their Twitter account
• Maybe have the tweets contain a link back to the website so users don't forget why they're sending these tweets

Readme

Write a good readme for the project.

Version 0.2: make it configurable

Description

People should be able to create their own website by simply:

1. clone the repo
2. change a yaml file
3. deploy to heroku
4. "just works™"

To-do

• find an easy way to allow non-programmers to config the app
  • see if https://github.com/railsconfig/config works fine with heroku
• allow people to change:
  • explanation of how it works in layouts/application
  • website title
  • twitter handle of the company
  • company name
  • customize the random tweets list
• remove the twitter messages that only works for banks, allow people to add their own through the settings file
• Write tutorial in portuguese in the README explaining how to deploy your own
• Q&A whole process

Add a default tweet message that advertises the website

It will be a way to advertise the website, to gather more people that hates the given company to sign up and start tweeting as well!

Maybe we should hardcode the message in the code so people can't easily remove it from the yaml file? Nothing like a shady thing but because I think most people will just remove all the messages without reading them.

Another option would be creating a new key in the settings just for this message which would allow people to easily change it 🤔

Add Google Analytics script and allow user to add their GA id in config

Set gemnasium up

https://gemnasium.com/

Improvements in the README

@maurogeorge gave some improvement suggestions:

• "No README trocar "Sobre o projeto" por "Cansei" e manter o mesmo texto. Só adicionar que é uma aplicação Rails em algum lugar dele."

• "Se rolar, seria legal neste começo fazer um gifzinho da App rodando. Tipo:

1. clico no "Entrar"
2. faz um fade in para algum tempo depois...
3. e mostra o tweet no twitter.

Eu demorei um pouco para entender o fluxo. Eu tinha entendido a proposta, mas não o fluxo.
O discourse tem imagens e o conf-boilerplate tem um vídeo."

• "Antes do "Como usar o projeto", cria um "Dependencies". Algo na linha que o Pah gera: https://github.com/Helabs/pah/blob/master/lib/pah/files/README.md#dependencies"

• "Trocaria o "Como usar o projeto" por "Setup" e manteria os demais blocos que escreveu, só vemoveria o 1., 2. etc dos titulos. Aqui incluiria apenas os 1, 2 e 3."

• "Criar uma sessão "Running the project" Na linha do https://github.com/Helabs/pah/blob/master/lib/pah/files/README.md#running-the-project. Acho maneiro já incluir como rodar as specs aqui também."

• "Tanto o deploy quanto o Teste por uns dias ser títulos H1, mantendo sua própria sessão."

• "Na parte do deploy:

  • Faltou explicar o minimo do heroku toolbelt(talvez tenha no item 3, mas não custa nada um passo 2 instale o toolbelt), nem que seja um link para o cara instalar, pois se o cara tentar dar o git push que você orienta não vai pra lugar algum.
  • Faltou dizer que tem que colocar o heroku scheduler.
  • Acho que tem que ser $ heroku run rake db:migrate"

Add preview tweet message(s) to homepage and configuration

This will build trust with the user and I think it will help conversion because users will know what to expect.

Set codeclimate up

https://codeclimate.com/

With this set up, I think we can close the #10, since the codeclimate also provides test coverage.

Set Ebert up

https://ebertapp.io