hsborges / gittrends-repository

Monitoring popular GitHub projects

GitTrends.app

The goal of this project is to collect and analyze information from public GitHub projects using GitHub GraphQL API - Access gittrends.app for more information.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• NodeJS
• MongoDB
• Redis
• Docker (Optional)

Installation

1. Clone the project

git clone https://github.com/hsborges/gittrends-repository.git

2. Install dependencies

yarn install

3. Configure the environment variables on .env or create a local/development/production config file

touch .env.local .env.development .env.production

4. Run database migrations

yarn workspace @gittrends/database migrate

Docker

You can also use docker containers:

# run containers
docker-compose \
  -f docker-compose.yml \
  -f docker-compose.service.yml \
  up -d

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Hudson Silva Borges - @hudsonsilbor - hsborges[at]facom.ufms.br

Project Link: https://github.com/hsborges/gittrends-repository

Acknowledgements

• Marco Tulio Valente