Appliance-Surge

README

Appliance Surge

The #1 Q&A site for all appliance repair needs!

Getting Started

git clone the repository, then run docker-compose up in the root directory.

Use the built in gopher commands to create the database migrations.

./gopher migrate up

Prerequisites

These tools must be installed to run the application

• Docker

These tools must be installed for development

• Goose

Installing

Here is how to get the application up and running

Clone the repository

git clone https://github.com/Appliance-Surge/Appliance-Surge.git

Run docker-compose up in the root directory. This should get the build the Go application, Postgres, and Adminer

docker-compose up

Use the built-in gopher command to run the migrations

./gopher migrate up

Gopher Commands

Run migrations

./gopher migrate up

Tear down migrations

./gopher migrate down

Rebuild migrations

./gopher migrate up --fresh

Create a migration

./gopher make:migration create_users_table

Run factories

./gopher factory

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Authors

• Damion Voshall - Maintainer - Github

See also the list of contributors who participated in this project.

License

This project is licensed under the LICENSE Creative Commons License - see the LICENSE.md file for details