#GitChecker GitChecker is an open source tool which aggregates statistics about Github projects.
Have you ever been stuck wondering whether or not to use a library or a framework, uncertain of how well it was maintained? Help is here!
##Disclaimer I know I am not using SCSS variables, but I was unable to get stylesheet imports to work and I was impatient. If anyone manages a pull request would be much appreciated.
##Stack
- Webpack
- Redux
- React
- React Router
- Elixir
- Phoenix
- PostgreSQL
##Todo/Ideas
- Add more statistics and metrics
- Devise an algorithm for calculating an overall activity/maintenance score based on aforementioned metrics
- Create an Elixir GenServer that manages resyncing projects, instead of initiating it from the client
- Clean up SCSS codes (perhaps using CSS modules or inline React styling)
- Add functionality and interface for comparing two repositories simultaneously
- Get Webpack's hot module replacement to work properly
##Installation
$ git clone [email protected]:madshargreave/gitchecker.git
$ cd gitchecker
$ mix deps.get
$ npm install
##Running in development Two run the application locally, the database must be prepared and an Github access token must be specified to be used in conjunction with the GitHub API.
###Database Run the following commands to create and migrate the database
$ mix ecto.create
$ mix ecto.migrate
###Github Access Token
Before running locally, you must create an .env file in the project root.
Example .env file:
export GITHUB_ACCESS_TOKEN="your github access token"
###Starting servers
You must start both the webpack development server and the Phoenix server in seperate terminal tabs. For convenience, a start script has been suppliedin the project root to source the .env file before starting the webserver.
Webpack (client):
npm start
Phoenix (server):
./start or source .env && mix phoenix.server
##Contributing
Happy to accept any feedback, bug reports and pull requests