letsgo

README

Let's GO

App to connect people for gatherings.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This is a side project I am working on during my last semester of a BS in Software Development.

Let's Go started as a way for families to organize cookouts, birthday parties, family reunions, etc. Then I thought, any group of people might want to gather for <insert reason>.

Built With

• Go
• Gin
• Gorm
• PostgreSQL
• Redis
• Docker

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This app can be deployed in docker.

• Docker

Installation

1. Clone the repo

   git clone https://github.com/rs401/letsgo.git
   

2. Setup Environment Variables

   mv env.sample .env
   vim .env
   

3. Orchestrate containers

   docker-compose up --build
   

Usage

Create an account. Join a group. Create a group. Post an event. Attend an event. Live life with Joy.

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 learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @Res401 - rich.stadnick#gmail

Project Link: https://github.com/rs401/letsgo

Acknowledgements