kyrene

Kyrene

Work in progress

Description

I got tired of having my snippets of code, which act as my go-to cheat sheets in multiple languages & frameworks, scattered all over multiple platforms (in some cases even pasting them to a conversation with myself in various messaging platforms).

Thus I decided to start work on a dedicated application which allows users to create their own sheet(s) with multiple segments of code related to a sheet.

Inspired by devhints.io

Technical overview

This project serves as a GraphQL based API written in Golang, which is consumed by the front-end via the Apollo client using React. State management is done via apollo-link-state and authentication is provided by JSON web tokens. Still work in progress.

Features

• Base queries & mutations for GraphQL
  • Actual working endpoints for queries & mutations
  • Creating sheets & segments
• Database integration
• Unit & integration tests for endpoints
• Front end base setup
  • Client side functionality integration
• JWT authentication
  • OAuth (Facebook?)
  • Wrap GraphQL queries in authentication HOF
• Docker
  • Development
  • Production
• Styles

Technologies

• Golang
• GraphQL
• PostgreSQL
• Docker
• React
• React-Router
• Apollo
• Webpack
• CSS modules
• Flow

Setup

Docker

Development

docker-compose up --build

¯_(ツ)_/¯

Non-Docker

• Start by setting env variables for Go (Note: $ implies using the terminal)

$ export GOPATH=$HOME/path/to/go/projects
$ export PATH=$GOPATH/bin:$PATH

• Proceed with Postgres env variables

$ export DBHOST=localhost
$ export DBPORT=<PORT> // default 5432
$ export DBUSER=<YOUR_USERNAME>
$ export DBPASS=<YOUR_PASSWORD>
$ export DBNAME=<YOUR_DB_NAME>

• Install dependencies via Glide

glide install

• Build the server executable

$ go build

• Run the server

$ ./kyrene

• Run the client side webpack-dev-server instance (served on localhost:8080)

$ npm run dev

• Production (served on localhost:8000)

$ npm run prod