Borderless Coding

A platform for Borderless members to connect, collaborate, and share knowledge within the community.

📌 Table of Contents

• 📌 Table of Contents
• 🚀 Get Started
  • 🖥 Installation
  • Configuration
    • 🪪 Credentials
  • Running
    • Migrations
    • Using Prisma Studio
    • Development server

🚀 Get Started

To clone the repository to your local machine, follow these steps:

1. Open a terminal
2. Navigate to the directory where you want to clone the repository
3. Execute the following command:

    git clone git@github.com:ProgramadoresSemPatria/sem-patria-community.git

or if you use HTTPS:

    git clone https://github.com/ProgramadoresSemPatria/sem-patria-community.git

    cd sem-patria-community

🖥 Installation

Once you have cloned the repository, you need to install the project's dependencies.

Use the recommended node version which is >=20.x

If you have nvm:

    nvm use

Install dependencies:

pnpm recommended

pnpm i

Configuration

Copy env example:

    cp .env.example .env

Set env values according to your credentials.

🪪 Credentials

1. Generate a personal key in your GitHub 1.1 Click in your user -> Settings -> Developer Settings -> Personal access tokens -> Generate a classic token
2. Change the value of variable GITHUB_TOKEN with the created token
3. Change the value of variable USERS_WHITELIST to your github username

⚠️ DO NOT COMMIT YOUR PERSONAL TOKEN

Running

Before start development server, you need to ensure that database is configured.

Migrations

To set up the database schema and apply any pending migrations, execute the following command:

pnpm migrate dev

This command will ensure that your database is up to date with the latest changes defined in your Prisma schema.

Using Prisma Studio

To visually explore and interact with your database, you can use Prisma Studio. Run the following command:

pnpm prisma studio

This will open Prisma Studio in your default web browser, allowing you to view and manipulate your data directly.

Development server

With the cloud database url

pnpm dev

Without the cloud database url (running postgreSQL locally with docker)

pnpm dev:local
- **Ensures users set up PostgreSQL correctly** (via Homebrew, Apt, or Docker).
- **Guides users through creating a Clerk account** and configuring authentication.

Open http://localhost:3000 with your favorite browser.