Git Product home page Git Product logo

snippet-box's Introduction

Snippet box App

Snippet box represents a standalone application that aims to provide necessary APIs to manage snippets domain. The Snippet box domain provide necessary operation for user to view and add snippets.

How to launch locally

Install necessary software

Software products and tools

  • go >= 1.17
  • PostgreSQL >= 11
  • Docker Engine

Service's dependencies

  • PostgresSQL

These services can be manually installed and configured or can be used semi-automatic scrips with docker engine.

Note: At the moment there are no instructions and/or script that provides support for manual installation. It is recommended to use docker engine.

How to start locally

Prerequisites: all service dependencies should be up and running and properly configured.

  • Build project:
go build -o main ./cmd/web/
  • Show available flag:
./main -help
  • Alternative - run on Docker:
docker-compose -f .\build\docker-compose.yaml up --build

How to play

Exposed API can be checked using exposed web page

Note Http server is started on port 4000`

Design Consideration

TBA

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.