Code Monkey home page Code Monkey logo

mzk's Introduction

Prerequisites

  • Golang installed
  • Postgres installed
  • DBMate installed. Or you can use dbmate via docker instead (using make command)
  • Docker (optional, if you want to run via docker instead)

How to run

Without docker

  1. Clone the repo
  2. Copy and paste .env.sample to .env. And the config in .env file.
  3. Make sure a database in ready in your Postgres
  4. Run a migrations using dbmate to create a table and seed data. dbmate -u "<database_url>" up. Example : dbmate -u "postgres://postgres:@localhost:5432/postgres" up. Make sure the database is same as defined in .env file
  5. Run make dev to run the server. It will running on port 6060 by default. make_dev img
  6. The API docs is available via Swagger. You can open it in http://localhost:6060/swagger/index.html swagger img
  7. You can try directly in Swagger. swagger-response img

With docker

  1. Clone the repo
  2. Run your docker
  3. Run make compose-up. It will prepare all you need to run the app. Spin up a Postgres container, build the app, and do a db migration. docker img
  4. The API docs is available via Swagger. You can open it in http://localhost:6060/swagger/index.html swagger img
  5. You can try directly in Swagger. swagger-response img

mzk's People

Contributors

vinbyte avatar

Watchers

avatar

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.