Skip to content

Commit

Permalink
Test publish wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
bterone committed Jun 15, 2022
1 parent 393b9f3 commit 6ae4e4d
Show file tree
Hide file tree
Showing 4 changed files with 97 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/wiki/Home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## G-Searcher

#### About The Project

G-Searcher is a Google Web Scraper. You upload a CSV with all the keywords you want searched, and let G-Searcher handle the rest!

- Upload CSV files for massive queries 📝
- Google Authentication 👮‍♀️
- Dedicated API endpoints 🎯
- Advanced filters to search through all your queries 🔎
- Sleek modern dashboard for your data needs 👩‍🏫
48 changes: 48 additions & 0 deletions .github/wiki/Setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
### Built With

* [Erlang/OTP 23.2.4](https://www.erlang.org/)
* [Elixir 1.11.3](https://elixir-lang.org/)
* [Phoenix Framework 1.5.5](https://phoenixframework.org/)

## Getting Started

### Prerequisites

You will require

* Docker
* [OAuth 2.0 Credentials](https://developers.google.com/identity/protocols/oauth2)

### Installation

To start G-Searcher:

* Clone the repo
```sh
git clone https://github.com/bterone/g-searcher
```
* Install dependencies
```sh
mix deps.get
```
* Start docker container
```sh
docker compose -f docker-compose.dev.yml up -d
```
* Create and migrate your database
```sh
mix ecto.setup
```
* Install Node.js dependencies with `npm install` inside the `assets` directory
* Fill in Oauth credientials to `dev.exs`
```elixir
config :ueberauth, Ueberauth.Strategy.Google.OAuth,
client_id: "<GOOGLE CLIENT ID>",
client_secret: "<GOOGLE CLIENT SECRET>"
```
* Start Phoenix endpoint with
```sh
mix phx.server
```

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
33 changes: 33 additions & 0 deletions .github/workflows/publish_wiki.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Publish Wiki

on:
push:
branches:
- chore/github-wiki

jobs:
publish:
name: Publish Github Wiki

runs-on: ubuntu-latest

timeout-minutes: 1

steps:
- name: Cancel previous runs
uses: styfle/[email protected]
with:
access_token: ${{ github.token }}

- name: Checkout the repository
uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}

- name: Publish Wiki
uses: nimblehq/[email protected]
with:
USER_EMAIL: [email protected]
USER_NAME: Terone
secrets:
USER_TOKEN: ${{ secrets.GH_TOKEN }}
5 changes: 5 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ jobs:
--health-retries 5
steps:
- name: Cancel previous runs
uses: styfle/[email protected]
with:
access_token: ${{ github.token }}

- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
Expand Down

0 comments on commit 6ae4e4d

Please sign in to comment.