dykatz/touch-grass

A free and open source web application for finding, joining and managing groups of people

TouchGrass

A free and open source web application for finding, joining and managing groups of people.

Getting Started

You need to have the following software packages installed for local development:

• Node.js
• Postgres

It is highly recommended that you use VS Code for development. If so, you will be prompted to install certain extensions.

To start a development server, first create a .env file:

cp .env-example .env

There are a few environment variables that need to be filled out:

• NEXTAUTH_SECRET is a random value, best generated by a command like:

openssl rand -base64 32

• DATABASE_URL is the URL of the database, which should be something like postgres://<user>@localhost/<db>
• DISCORD_CLIENT_ID and DISCORD_CLIENT_SECRET are secret values for using Discord for the application registration
  • Follow this guide for more information about getting these values
  • Change /src/pages/api/auth/[...nextauth].ts and /src/env/schema.mjs to configure NextAuth to use different/additional providers.

Finally, the development server can be started with:

npm run dev

And the main page can be accessed at http://localhost:3000.

Technologies Used

TouchGrass is built on the T3 Stack, which is the combination of the following technologies:

• Next.js
• NextAuth.js
• Prisma
• TailwindCSS
• tRPC

It allows for rapid development with full-stack type safety.

Code Tour

Path	Description
/prisma/schema.prisma	The database schema
/src/components/	Shared components
/src/pages/api/auth/[...nextauth].ts	NextAuth configuration
/src/pages/**.tsx	Pages
/src/server/router/*.ts	tRPC API calls

License

TouchGrass is licensed under the AGPLv3 license. See LICENSE.md for more information.