An open API service indexing awesome lists of open source software.

https://github.com/moralcode/forgefind

A simple website for finding repositories across multiple different git hosting providers.
https://github.com/moralcode/forgefind

Last synced: 7 months ago
JSON representation

A simple website for finding repositories across multiple different git hosting providers.

Awesome Lists containing this project

README

          

# ForgeFind

This is a simple, hacked-together python webapp to serve as a proof-of-concept dempnstration of a search tool similar to https://grep.app that can search multiple different code hosting platforms.

![a screenshot of the homepage](images/home.png)

![a screenshot of the results page](images/results.png)

## Setup and running
1. `pipenv install`
2. (optional) create a .env file according to the env variables below
3. `FLASK_APP=app pipenv run flask run`

### Environment variables
`GITLAB_TOKEN` - [a token appropriate for accessing the gitlab.com api](https://docs.gitlab.com/ee/api/#authentication).

## Hosting
There is a docker container intended for hosting this. to build it run `docker build -t forgefind .`, to run it interactively, use `docker run -it --rm -p 5000:5000 forgefind`

You will need to specify your environment variables when running the container either using `--env-file=.env` or specifying each variable with `-e`

## Forge support:
Currently the following forges are included in results:
- Github
- GitLab
- Gitea

## Project Limitations/intentions

Currently this project is intended to be a proof of concept.

It mostly relies on anonymously accessing public API's of various hosting providers and is therefore not able to handle the kinds of high-volume use that can result from having more than a few users. Therefore this should be considered to be "for personal use"