Use standardjs rules for linter

Lets use Standard JS rules for eslint.
This can be achieved by adding extends: 'standard' to .eslintrc.js and adding the required dependencies to package.json (to devDependencies).

More details in https://github.com/standard/eslint-config-standard

extend standardjs rules
add standardjs dependencies
fix javascript files (eslint --fix should do for most of the cases)

Add .npmrc with default npm registry

Some companies use a custom npm registry set at ~/.npmrc.

To prevent failures on npm install, let's add our own .npmrc to the project.
A simple registry line is enough.

registry=https://registry.npmjs.org/

Error: Cannot find module 'dotenv'

Problem description

Heroku install nod modules with --only=prod option, so it won't install devDependencies.
Since our dotenv is required at index.js, the server fail to load.

Error: Cannot find module 'dotenv'

Proposed solution

One of the options bellow:

Move dotenv to dependencies or
add a try {} catch block around it on backend/index.js

Serve the front-end from the back-end

If we publish to heroku, we need a single webserver, listening to $PORT.

So let's use express static feature to host the front-end build on dist/
Also...

change serve-backend script to start
add npm run build to prestart script

[Sticky] About Hacktober Rank Challenge

en_US:

@nolleto challenged me to create a whole project, from beginning to end, without writing a single line of code. All features should be done through pull requests from other users. I'm only allowed to:

Create issues
Comment on issues and pull requests
Suggest code improvements on pull requests
Write documentation: README, CONTRIBUTING, etc

The challenge will be achieved if it is a working project, published on a web host, on November 1st, 2019.

pr_BR:

@nolleto me desafiou a criar um projeto inteiro, do início ao fim, sem escrever uma única linha de código. Todas funcionalidades deverão ser realizadas através de pull requests de outros usuários. Eu posso apenas:

Criar issues
Comentar em issues e pull requests
Sugerir melhorias de códigos em pull requests
Escrever documentação: README, CONTRIBUTING, etc

O desafio será terminado com êxito se resultar num projeto funcional, publicado na internet, até 1º de Novembro de 2019.

Fetch github in a worker to update databse/cache

These issues must be done first:

#3 Bootstrat the project
#4 Fetch github PRs
#5 Add database

Create a worker to run once an hour to update our dabase/cache.

The worker must check for duplications and only add new pull requests to database.
All web server requests should, then, read from the database and not from the GitHub api.

Booststrap the project

Bootstrap the initial project, which shall include:

a working webserver
a landing page
a test suite (a single dumb passing test is enough)
a .gitignore to match the language and framework of choice

The language and framework could be any fairly popular language.
I suggest Ruby or Node.js which are the ones I'm more used to work and will ease my reviews.

Publish project website

Prerequisites

#3 must be done first
#30 must be done first

Tasks

Set everything required to run on the webserver of choice, including config files, replaces static content with environment variables, etc (e.g. app.json)
Add example config files (e.g. .env.example)
Add instructions to README on how to publish
Open a pull request with the changes
Publish the pull request branch on a server and add the link on the description

Heroku (http://heroku.com/) is a good choice and easy option.

Fix host and port for front-end

Describe the bug

We need to have a better control over env vars to allow the project to run on a web server.
In short, we need a way to inform the correct backend url.

Changes to do

Update src/api.js and set:

host to process.env.VUE_APP_DEFAULT_BACKEND_HOST || 'http://localhost'
port to process.env.VUE_APP_DEFAULT_BACKEND_PORT || 8001
axios.get(${host}:${port}/api/v1/pulls/${year})
add VUE_APP_DEFAULT_BACKEND_HOST to .env.example

Add CI test with Travis-CI

Travis CI (https://travis-ci.org/) is a good option, but not the only one. Feel free to choose the one you like most.

Improve fix linter for CI

There are some changes we should do to improve our code lint.

do not fix linter errors or warnings
do not allow warnings
change no-console/no-debugger rules
- add debug (https://www.npmjs.com/package/debug) module and use it instead of console.log
prefer const when not reassign
lint tests/ folder as well
fix new issues fond

This can be achieved by adding or changing:

// in package.json
"lint": "vue-cli-service lint --no-fix --max-warnings 0 src/ backend/ tests/"

// in .eslintrc.js
rules: {
  'no-console': 'warn',
  'no-debugger': 'warn',
  'prefer-const': 'error',
},

Write README

Add a README describing the project intention and challenge.

Note: See other issues for details.

Remove [bot]s from results

We don't want to list bots in the rank, which usually create auto pull requests to upgrade forks from upstream branches or from repositories outside github.

Filter out any username that has a [bot] suffix
The easiest way is to just add a .filter to the results we get from redis.

Alternatively, we could filter when fetching from github and not save on redis at all. For this option, check if github search api allows to exclude bots from results or to add an exclude filter for the search.

Enable HTTPS

The current backend works only with HTTP.
We must update to allow https as well.

~~Note: Heroku won't work without this.~~

I'm not 100% sure, this is needed.
Heroku should be able to forward https requests to an http backend.

Still researching.

Fetch and list github pull requests

#3 must be done first.

Use Github Search API (https://developer.github.com/v3/search/#search-issues-and-pull-requests) to fetch pull requests in the selected period.

The search should filter by date, from October 1st to October 31 for the selected year (it can be fixed to 2019 for start) and group by user. Then sort the results in descending order (more contrubutions to less).

Note that github api has a query limit. Try to get the results in a single request.

Details for searching issues and pull request can be found at https://help.github.com/en/articles/searching-issues-and-pull-requests

Styles improvement

It would be nice to have a new style front-end part.
We had some unfinished work on the following PRs that could be a good start:

#39 (reverted)
#41
#43

Related to #8

Apply recommended community standards.

Github checklist for recommended community standards.

https://github.com/paulodiovani/hacktoberrank/community.

Open Pull requests accordingly.

Add a simple database to the back-end

#3 must be done first

Database will be, for start, just a long-term cache to prevent fetch from github api all the time. Redis would be good enough but we could also use Postgress or MongoDB as alternative.

The database should keep a cache of contributions per user and links to pull requests.
We can simple store username alongside pull request link to allow search/filter/group by user.

Suggested schema:

user: String (github username)
project: String (project name)
pull_request: String (pull request link)

Make front-end pretty

#3 must be done first

Add styles to make the front-end landing page pretty.

Optionally add your preferred CSS Framework (Bootstrap, Foundation, Miligram, Bulma...)

paulodiovani / hacktoberrank Goto Github PK

hacktoberrank's Introduction

Hacktober Rank Challenge

Project Description

Contributing

Dependencies

Project setup

Compiles and hot-reloads for development

Compiles and minifies for production

Lints and fixes files

Run your end-to-end tests

Run your unit tests

Fetch pull requests script to update database with pull requests

hacktoberrank's People

Contributors

Stargazers

Watchers

Forkers

hacktoberrank's Issues