README.md

Report a Bug

Table of Contents

• About
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Support
• Project assistance
• Contributing
• Authors & contributors
• Security
• License
• Acknowledgements

---

About

InReach is the world’s first tech platform matching LGBTQ+ people with safe, verified resources.

InReach is for the entire diverse LGBTQ+ community – including asylum seekers and refugees, undocumented and other immigrants, young people experiencing homelessness, those facing family or community rejection due to their identity, and other transgender and non-binary people in need of safe resources.

Built With

• T3 Stack [Docs]
  • Next.js [Docs]
  • Prisma [Docs]
  • tRPC [Docs]
  • Next-Auth [Docs]
  • TypeScript [Docs]
• Mantine [Docs]
• Storybook [Docs]
• pnpM [Docs]

Getting Started

Prerequisites

This project uses pnpm to manage packages. To install, run the command:

npm -g install pnpm

or follow the instructions on pnpm's installation page.

Installation

To install the required packages & dependencies:

pnpm install

Usage

To start the development live servers:

pnpm dev      # Starts Next.js
pnpm dev:ui   # Starts Storybook for UI component development

Next.js based projects will be available at http://localhost:3000

Storybook will be available at http://localhost:6006

A Docker Compose file has been provided to spin up a local PostgreSQL instance. To start/stop a local database:

pnpm db:up               # Starts the database
pnpm db:down             # Stops the database

pnpm db:migrate          # Generate a Prisma migration
pnpm db:migrate:apply    # Apply a Prisma migration to a dev instance

pnpm db:deploy           # Apply a Prisma migration to a prod instance

More information about Prisma migrations can be found here

Support

Reach out to the maintainer at one of the following places:

• GitHub issues
• Contact options listed on this GitHub profile

Project assistance

If you want to say thank you or/and support active development of InReach:

• Add a GitHub Star to the project.
• Tweet about InReach.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make InReach better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by InReach.

For a full list of all authors and contributors, see the contributors page.

Security

InReach follows good practices of security, but 100% security cannot be assured. InReach is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the GNU General Public License v3.

See LICENSE for more information.

Acknowledgements