README
¶
Go Party Finder
Find other players for your D&D game (toy app)
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
I've started learning Go, and I'm using this project to solidify my learnings.
Go Party Finder is a toy application to find a group of folks who want to play D&D or another pen and paper role-playing game (a “party”).
The project is a work in progress.
Built With
Getting Started
To get a local copy up and running follow these steps.
Prerequisites
For local development, you should have Docker, docker-compose, and Go >= 1.11 installed.
If you are able to run make, you can use the included Makefile.
Installation
- Clone the repo
git clone https://github.com/sophiabrandt/go-party-finder.git
- Spin up the docker containers (in detached mode):
docker-compose up -d
Usage
- Run database with Docker/docker-compose:
make up
- Run migrations and seed:
make seed
- Start application locally:
make dev
Navigate to https://localhost:8000.
Tests
go test -v ./...
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
Please update tests if necessary.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the Apache 2.0 License. See LICENSE for more information.
Contact
Sophia Brandt - @hisophiabrandt
Project Link: https://github.com/sophiabrandt/go-party-finder
Acknowledgements
- Let's Go! by Alex Edwards
- Every Layout by Heydon Pickering & Andy Bell
- ardanlabs/service by ArdanLabs
- cloud native app by Dumindu Madunuwan
- Building Modern Web Applications with Go (Golang) by Trevor Sawler
Directories
¶
| Path | Synopsis |
|---|---|
|
business
|
|
|
data/party
Package party contains party-related CRUD functionality
|
Package party contains party-related CRUD functionality |
|
data/schema
Package schema contains the database schema, migrations and seeding data.
|
Package schema contains the database schema, migrations and seeding data. |
|
mid
Package mid contains the set of middleware functions.
|
Package mid contains the set of middleware functions. |
|
cmd
|
|
|
admin/commands
Package commands contains the functionality for the set of commands currently supported by the CLI tooling.
|
Package commands contains the functionality for the set of commands currently supported by the CLI tooling. |
|
foundation
|
|
|
database
Package database provides support for access the database.
|
Package database provides support for access the database. |