MeetUp Clone

A backend API for a meetup-clone

Getting Started

• Install dependencies

go mod tidy

• Create a .env directory and add api.env and postgres.env files

mkdir .env
touch .env/api.env
touch .env/postgres.env # Only needed if you are using `docker-compose.dev.yml`

• Add environment variables to the .env/*.env files

  • .env/api.env

    # App environment variables
    export DEBUG=true
    export FRONTEND_URL=http://localhost:3000
    # API_URL should match SERVER_ADDR
    export API_URL=localhost:8000
    export SECRET_KEY=<secret-key>
    
    # Server environment variables
    export SERVER_ADDR=:8000
    # SERVER_ENVIRONMENT: dev, test, prod
    export SERVER_ENVIRONMENT=dev
    
    # Database environment variables
    export DB_ADDR=postgres://<user>:<password>@<host>:<port>/<dbName>?sslmode=disable
    export DB_MAX_OPEN_CONNS=30
    export DB_MAX_IDLE_CONNS=30
    export DB_MAX_IDLE_TIME=15m
    
    # JWT environment variables
    export JWT_ISSUER=meetup_clone
    export JWT_AUDIENCE=meetup_clone
    export JWT_SECRET_KEY=<jwt-secret-key>
    export JWT_ACCESS_EXP=3
    
    # Cache environment variables
    export MEMCACHED_CONNS=<host>:<port>,<host>:<port>
    
    # Test environment variables
    export TEST_DB_ADDR=postgres://<user>:<password>@<host>:<port>/<dbName>_test?sslmode=disable

  • .env/postgres.env - Only needed if you are using docker-compose.dev.yml

    POSTGRES_PORT=5432
    POSTGRES_USER=postgres
    POSTGRES_PASSWORD=postgres
    POSTGRES_MULTIPLE_DATABASES=meetup, meetup_test
    TZ=UTC
    PGTZ=UTC

• Start the api services i.e postgres

  NOTE: This step is for only those using the docker option. If you have local instances, skip this step.

make services-up
# OR if you need sudo
sudo make services-up

# Stop the services
make services-down

# Stop services and destroy container
make services-kill

• Run migrations on the test and main db

  NOTE: You must have migrate installed.

make migrate-up
make test-migrate-up

• Run tests

make test

# Tests with coverage
# Create a coverage.out directory before running tests with coverage
make test-cov

• Run server

make gen-docs && make runserver
# or you can use air
air