Skip to content

gjillo/gjillo-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gjillo API

This repository contains only the API's code. For the main repository, see Gjillo/gjillo-app

Tech Stack

Installation

Prerequisities

  • PostgreSQL database
  • Node.js

Database

Import database.sql into your PostgreSQL database

API

Clone this repo on your local machine

git clone https://github.com/gjillo/gjillo-api.git
cd gjillo-api

Install node modules

npm install

Create .env.local file and fill in the database credentials, as described in the .env file, for example:

DB_HOST="your-postgres-database.com"
DB_PORT=5432
DB_USER="postgres"
DB_DATABASE="gjillo"
DB_PASSWORD="your-password"

Start live server

npm run start

API will be available at localhost:4000.

GraphQL Playground will be available at localhost:4000/graphql.

Docs

To generate docs start server and run

npm run docs

Docs will be available at localhost:4000/docs/api/

Authors

License

This project is licensed under MIT license.