Categorygithub.com/pergamene/project-spiderweb-service
repository
0.0.0-20200320214449-3ac20e90d62a
Repository: https://github.com/pergamene/project-spiderweb-service.git
Documentation: pkg.go.dev
Overview
Dependencies
0
Dependents
0

# Packages

No description provided by the author

# README

Project Spiderweb - Service

License; use, modification, sharing, and distribution

  • This project does not have an Open Source license and its copyright is only extended to the specified authors.

  • You are not permitted to share the software.

  • You are not permitted to distribute the software.

  • You are not permitted to modify the software.

  • You are not permitted to use the software, except at its hosted URL.

  • You are, however, permitted to view and fork this repo.

You can read more about our permissions at https://choosealicense.com/no-permission/

Development

Contributing

If you want to get started on contributing, head over the Root Project Page and either check out the Issues or Projects. Not sure where to start? You can post your interest here and we'll get you started.

We keep a separate repo for Issues/Projects because the project spans more than one repo (front-end, back-end, etc). If there is an issue specific to only this project, you can just post an issue here.

Adding dependencies

Dependencies are installed using govendor until go2 is released.

Installation
go get -u github.com/kardianos/govendor
Use
govendor fetch <same as "go get" path>

Setup

See the Go Getting Started page for details on how to set up your machine for Go development.

go get github.com/Pergamene/project-spiderweb-service

Testing

First, install testify, which is used for unit test mocks and assertions: go get github.com/stretchr/testify.

To run the unit tests, you can run go test ./....

If you're writing new unit tests, you'll likely need to install mockery to mock interfaces.

If you want to run the intregated tests against the db, make sure to:

  1. Set the env var SETUP_SQL_FILEPATH to the filepath of where the db's setup.sql file is on your local machine:
export SETUP_SQL_FILEPATH=/Users/rhyeen/Documents/repos/project-spiderweb/project-spiderweb-db/setup.sql
  1. Have the database docker container running locally. Follow the README.md for instructions.

Build/Run

To build the app, cd cmd/server and run go build. This will create a server executable that you can run

./server

You'll then be able to hit the service at http://localhost:8782 try hitting http://localhost:8782/healthcheck to see the basic service is working or http://localhost:8782/dbhealthcheck to see if it can successfully connect to the database.

Serving API Docs locally

The API docs can be accessed when the server is running locally at: http://localhost:8782/api/docs.