Skip to content

Latest commit

 

History

History
111 lines (81 loc) · 3.65 KB

README.md

File metadata and controls

111 lines (81 loc) · 3.65 KB
Raw

Goact

Overview

This is a base repo for using React client-side rendering and a Go backend, using Clerk.com as the authentication service

Features

Dashbaord

Dashboard

Users Powered by Clerk

Profile

Messages

Overview

Message Overview

Group Messages Message Group

  • Websocket Messages
    • You can go to /messages on the client and send yourself messages.
      • You can create multiple "groups" and send messages to each "group" that you have created. This is the start of that functionality and is subject to change.
      • You currently have to manually add users to groups. This will be changed once we figure out a safe way to allow you to choose users to add
    • We have connected the Client code to the Server code via Websockets
      • The interface is still being figured out and is subject to change
      • The Websocket messages are integrated with Redux so that all messages that come from the Websocket messages server are sent directly to the Redux store in order to allow us to trigger logic based on server-sent events in the same way we would handle it if the client sent the event themselves

Communities

  • Communities are the top level that we are using as a way to group different things together.
    • The whole point of this application will be to help you experience life together with your communities while being apart geographically.
    • All users will be a part of one or many Communities and will be able to interact with anyone in any community that they are a part of
    • Communities can be public or private. public communities will show up for everyone to join while private will be invite only.
    • We will connect the group messaging to the communities domain so that you can select people to message and to add to group messages based on the groups that you are in.
      • We are not sure if we will allow you to have group messages with people across groups or not. This is still in development

Docs

  • Swagger Docs
    • You can go to /docs on the API service to find Swagger docs and a UI for exploring the APIs available.
  • Authentication via Clerk
    • We are syncing the data from Clerk into the application via webhooks
    • You will need to register the appropriate URL for your environment in your own Clerk dashboard
      • If you do not, you will not have Users inside of the database automatically when they sign up in Clerk. Which means you will need to manually INSERT INTO users(externalId) VALUES('user_id_123') each time you want to onboard a User.recreate
      • For local development/testing, we are using ngrok

Development

Backing Services

make start-services # start services
make stop-services # stop services, keeps data
make restart-services # destroy services, loses data

Database Migrations

make migrate-up # migrates the database up per environment variables. See scripts/migrate-database.sh
make migrate-down # migrates teh database back one migration. See scripts/rollback-database.sh

./scripts/create-migration my_migration # creates a new migration file in migrations/

API

# Copy over basic env file
# TODO: fill out with your
# specific values before starting
cp .env.example .env
make dev-server # go run .

Client

make dev-client # cd client && pnpm dev

Future Features

Communities

Member Profile

  • Email address
  • Allergies