flow-backend

module
v0.0.0-...-23b5947 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 15, 2024 License: MIT

README

flow-backend

A GraphQL Server for mobile application about time and task management called Flow. This server was built as part of bachelor thesis.

Getting Started

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

Prerequisites
  • Docker
  • Docker Compose
Running the server
  1. Clone the repo
  2. Run the following command to start the server $ docker-compose up. This will run the environment containing necessary tools.
  3. The server will be running on http://localhost:3000

Note: It is encouraged to modify the Dockerfile environment variables to match your certificate details.

Development

It is possible to run the server alone, however, following conditions must be met:

Once the conditions are met, follow these steps:

  1. Clone the repo
  2. Copy the .env.example file to .env and fill in the necessary information
  3. Run the migrations by running the following command $ go run cmd/db/main.go
  4. Run the following command to start the server $ go run cmd/server/main.go. This will run the server in development mode.

Directories

Path Synopsis
cmd
db command
server command
internal
msg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL