Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.74 KB

README.md

File metadata and controls

60 lines (39 loc) · 1.74 KB
Raw

Route

Route is a platform that allows users to easily share their favourite links, tech skills and GitHub stats in one centralized place.

Route Logo

Chat

🎮 Features

  • Showcase your favorite links like Linktree
  • Showcase your Tech Stack with a cool design
  • Automatically show your Github stats
  • Shareable link at https://route2.dev/yourusername

🔮 Tech Stack

  • FullStack Framework: SvelteKit
  • Styling: Shadcn-Svelte && Tailwind
  • Database: PostgresQL (Prisma as ORM)

🫂 How to Contribute

  1. Clone the project
git clone https://github.com/s1lvax/route
  1. Install dependencies
pnpm i
  1. Run a Postgres instance (I recommend using Docker CLI on Linux/Mac or Docker Desktop on Windows)
docker run --name your_postgres_container -e POSTGRES_USER=your_username -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=your_database -p 5432:5432 -d postgres
  1. Update the example.env to .env and fill in your data
  2. Push the database schema using Prisma
npx prisma db push
  1. Start the dev server
pnpm dev
  1. Develop the change using a separate branch, either bugfix/name or feature/name
  2. Push your changes and open a Pull Request with details about your changes. Pull requests must be made to the dev branch

A deployment of the dev branch exists at https://testing.route2.dev/. The dev branch is merged into main for each new release, and the latest release is deployed at https://route2.dev/

All Pull Requests are very appreciated :D