CoopStories (backend)

Write stories with friends.

Prerequisites

• NodeJS > v16.13.2
• Yarn
• PostgreSQL DB running

Setup

# Install dependencies
yarn install

# Configure .env variables
cp .env.example .env

# Run DB migrations
yarn migrations:up

# Start server (dev mode)
yarn dev

# Open your browser on localhost:4000/graphql to access GraphQLi

Deployment

This project is deployed with docker compose and requires you to have it installed locally. The repo provides an example docker-compose.yml file of how to run coopstories on your own servers.

First, go to the frontend docs and build the frontend image specifying the URL where your backend would be hosted.

Second, you need to configure the env vars on .env.dist. Before running the stack, read the docker-compose.yml and adjust the needed values. Once checked, we are ready to jump into the terminal.

# Check if the config is well formatted
docker compose -p coopstories --env-file .env.dist config

# Run our stack
docker compose -p coopstories --env-file .env.dist up -d

# Remove the stack
docker compose -p coopstories --env-file .env.dist down

# Rebuild stack's images (useful while developing)
docker compose -p coopstories --env-file .env.dist build

About the project

This project was made for educational purposes, I wanted to try some new technologies such as:

• GraphQL using GraphQL-Helix
• Prisma ORM

If you find anything that could be improved feel free to open an issue in this same repo.