Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.5 KB

README.md

File metadata and controls

38 lines (27 loc) · 1.5 KB
Raw

Github Oauth Api

An api that connects with github's api via github's Oauth service

Installation Guide

  1. Install Chocolateywindows
  2. Install Make choco install make windows
  3. Install Scoop
  4. Install migratescoop install migrate
  5. Install Docker

Setup Local Environment

  1. Create in root directory .env and token.env files

  2. token.env has one parameter ACTIVE_TOKEN which shouldn't be filled by default

  3. .env has the following parameters

    1. DB_URL will contain the db url for the migration file it will have this format postgres://username:password@host:port/database?host=/var/run/postgresql/data&sslmode=disable

    2. CLIENT_ID will contain client ID from the Oauth2.0 application of Github

    3. DB_URL_API will contain the database url that the dockerized api will access

      postgres://username:password@host:port/databasename

    4. CLIENT_SECRET will contain client secret from the Oauth2.0 application of Github

Start the environment

Open a powershell terminal and run the following command in project's root directory to create the migrations

make migrate

Run the following command to start the project

make up