README
¶
Conduit
A place to share your knowledge.
📖 Contents
⚡️ Technologies
🍕 Getting Started
Setting up environment variables
Before getting started, create .env file following the .env.example file.
Running conduit
- Docker (recommended)
$ make up
Once you're done working, use make down command to stop the docker containers.
👏 Contribute
Contributions are welcome as always, before submitting a new PR please make sure to open a new issue so community members can discuss it. For more information please see contribution guidelines.
Additionally, you might find existing open issues which can help with improvements.
This project follows a standard code of conduct so that you can understand what actions will and will not be tolerated.
📄 License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
app/api
Package api provides a application interface.
|
Package api provides a application interface. |
|
config
Package config provides a singleton instance of the configuration.
|
Package config provides a singleton instance of the configuration. |
|
controller/http/handler
Package handler provides a http handler.
|
Package handler provides a http handler. |
|
controller/http/httperr
Package httperr provides a http error responses.
|
Package httperr provides a http error responses. |
|
controller/http/middleware
Package middleware provides a http middleware.
|
Package middleware provides a http middleware. |
|
domain
Package domain provides a domain service.
|
Package domain provides a domain service. |
|
domain/profile
Package profile represents a profile domain.
|
Package profile represents a profile domain. |
|
domain/user
Package user represents a user domain.
|
Package user represents a user domain. |
|
repository/psql
Package psql represents a repository for PostgreSQL.
|
Package psql represents a repository for PostgreSQL. |
|
repository/psql/mocks
Package mock_psql is a generated GoMock package.
|
Package mock_psql is a generated GoMock package. |
|
pkg
|
|
|
filter
Package filter provides filters for squirrel.
|
Package filter provides filters for squirrel. |
|
hash
Package hash implements the password hashing algorithms.
|
Package hash implements the password hashing algorithms. |
|
httpserver
Package httpserver provides a simple HTTP server.
|
Package httpserver provides a simple HTTP server. |
|
logger
Package logger provides a wrapper for the zap logger.
|
Package logger provides a wrapper for the zap logger. |
|
pagination
Package pagination provides pagination.
|
Package pagination provides pagination. |
|
postgres
Package postgres implements postgres connection.
|
Package postgres implements postgres connection. |
|
slugerr
Package slugerr provides custom error types for the openapi HTTP API.
|
Package slugerr provides custom error types for the openapi HTTP API. |
|
token
Package token provides a web token maker.
|
Package token provides a web token maker. |
Click to show internal directories.
Click to hide internal directories.