README
¶
Let's Meet
Organize events for people with similar interests - app written in Go
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.
Let's Meet allows you to create events for people with similar interests. (Yes, it's a clone of a popular app.)
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/lets-meet.git
- Spin up the docker containers (in detached mode):
docker-compose up -d
Usage
-
Run both app and database with Docker:
docker-compose up -
Run database migration and seed data:
make seed
Navigate to https://localhost:8000.
Local Development
The docker container doesn't allow for a fast feedback loop as it compiles the Go binary. For development, it's encouraged to run the database via Docker. Run Go locally on your machine with go run.
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.
- 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 License 2.0. See LICENSE for more information.
Contact
Sophia Brandt - @hisophiabrandt
Project Link: https://github.com/sophiabrandt/lets-meet
Acknowledgements
- ardanlabs/service by ArdanLabs
- Let's Go! by Alex Edwards
- CaiuSS by Ionică Bizău
- Every Layout by Heydon Pickering & Andy Bell
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
meets-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. |
|
business
|
|
|
data/meet
Package meet contains user related CRUD functionality.
|
Package meet contains user 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. |
|
forms
package forms handles the business logic for form data
|
package forms handles the business logic for form data |
|
mid
Package mid contains the set of middleware functions.
|
Package mid contains the set of middleware functions. |
|
templates
Package templates sets up the cache for the HTML templates
|
Package templates sets up the cache for the HTML templates |
|
tests
Package tests contains supporting code for running tests.
|
Package tests contains supporting code for running tests. |
|
foundation
|
|
|
database
Package database provides support for access the database.
|
Package database provides support for access the database. |
|
web
Package web contains a small web framework extension.
|
Package web contains a small web framework extension. |