Skip to content

diegomichell/opensource

 
 

Repository files navigation

Local open source communities

http://developersdo.github.io/opensource – Coming soon!

This repository host the source code of the upcoming http://developersdo.github.io/opensource website.

Local open source communities is an initiative to gather all possible public data about users and repos from Dominican Republic in GitHub using the GraphQL API. Then build and serve a public website showing all the local effort that Dominican are contributing towards open source.

Want to join?

There are different ways you can join in this local effort:

  • You can include your GitHub users by adding the term “dominican” to your profile's location. Note: Dominicana is also accepted.
  • You can improve the code of the website or the scraper.
  • And if you don't code you can check the grammar, the UX, the graphic design, report bugs, it is up to you ;)

Development

If you want to run this project locally you will need: NodeJS 8+. After git-cloning this project do:

  1. yarn install
  2. Copy config/default.json to config/development.json.
  3. Generate a GitHub personal access token.
  4. Add your GitHub personal access token to config/development.json (this file is git-ignored).

That's it! Happy coding.

Development scripts

  • yarn sequelize – to use sequelize, pass cli args as follow: yarn sequelize -- db:migrate.
  • yarn scrape – scrape for all GitHub users and repos as configured.
  • yarn scrape:users – scrape for all GitHub repos.
  • yarn scrape:repo – scrape for all GitHub users.
  • yarn generate – generate GitHub users and repos for front-end usage.
With ♥︎ from all contributors.

About

Local open source communities

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 94.1%
  • HTML 3.6%
  • CSS 2.3%