Skip to content

Latest commit

 

History

History
103 lines (80 loc) · 3.54 KB

README.md

File metadata and controls

103 lines (80 loc) · 3.54 KB
Raw

Admin

The backend administration application of the Croct plataform.

Language Build Coverage Maintainability

📦 Releases · 🐞 Report Bug · ✨ Request Feature

Instructions

Follow the steps below to create a new repository:

  1. Customize the repository
    1. Click on the Use this template button at the top of this page
    2. Clone the repository locally
    3. Update the README.md and package.json with the new package information
  2. Setup Code Climate
    1. Add the project to Croct's code climate organization
    2. Go to Repo Settings > Test coverage and copy the "TEST REPORTER ID"
    3. Go to Repo Settings > Badges and copy the maintainability and coverage badges to the README.md
    4. On the Github repository page, go to Settings > Secrets and add a secret with name CC_TEST_REPORTER_ID and the ID from the previous step as value.

Installation

Use the builtin go get to add the package:

go get github.com/croct-tech/project-go

Basic usage

package main
import (
    "github.com/croct-tech/project-go/packageName"
)

func main() {
    project.Foo()
}

Contributing

Contributions to the package are always welcome!

  • Report any bugs or issues on the issue tracker.
  • For major changes, please open an issue first to discuss what you would like to change.
  • Please make sure to update tests as appropriate.

Testing

Before running the test suites, the development dependencies must be installed:

go mod download

Then, to run all tests:

go test

Run the following command to check the code against language builtin SAST:

go vet

To validate the language code style and guidelines install GolangCI-lint and run:

golangci-lint run

Building

For libraries, there is no need to build the project for publishing.
Binaries can be built using:

go build

License

Copyright © 2015-2020 Croct Limited, All Rights Reserved.

All information contained herein is, and remains the property of Croct Limited. The intellectual, design and technical concepts contained herein are proprietary to Croct Limited s and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Croct Limited.