Skip to content

SadanandMiskin/profilesMe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ProfilesMe

ProfilesMe is a profile builder platform similar to guns.lol that allows users to create a single, comprehensive profile link to showcase all their online presence.

Screenshot from 2024-11-21 21-20-29

v.webm

Features

  • 🔗 One Link for All Destinations
  • ✨ Customizable Beautiful Design
  • 🚀 Easy Profile Sharing
  • Video and Image Adjustable Background

Tech Stack

FrontEnd

  • React
  • Tailwind CSS
  • ShadcnUI
  • Aceternity UI
  • Lucide React
  • TypeScript

BackEnd

  • TypeScript
  • NodeJS
  • Express
  • MySQL
  • MongoDB
  • Google OAuth

Getting Started

Prerequisites

  • Node.js (v18+)
  • npm or yarn

Installation

  1. Clone the repository
git clone https://github.com/sadanandmiskin/profilesme.git
  • Create a .env file in /backend with:
DB_HOST=  #Mysql
DB_USER=
DB_PASSWORD=
DB_NAME=
PORT=
GOOGLE_CLIENT_ID=  #get it from google cloud console
GOOGLE_CLIENT_SECRET=
JWT_SECRET=  # Random String
SESSION_SECRET=  # Random String
FRONTEND_URL=
MONGO=mongodb://mongo:27017   #mongo uri

Using Docker (Recommended)

  • First Install docker and docker compose.
  • Then:
cd profilesMe
  • Run the whole app container
docker compose up
# Or
# docker-compose up

Or

Using npm - yarn

Running Backend-

  • Environment Setup
cd backend
yarn install
  • Run the server
npm run Dev

Running the frontend-

  1. Install dependencies
cd frontend
yarn install
  • Change the backend url in frontend/src/backendUrl.ts
  • Add the fronend Url in .env file in /backend
  1. Run the development server
npm run dev

OR

Build in production

npm run build
  • then serve
npx serve -s dist -p 5173

About

A Guns.lol like clone, a MVP

Resources

License

Stars

14 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors