/OpenLink

๐Ÿ”— Minimalist App for your links.

Primary LanguageTypeScriptMIT LicenseMIT

Screenshot

๐Ÿšง This project is under development ๐Ÿšง

โš™๏ธ Stack

๐Ÿ›ฃ๏ธ Roadmap

  • โŒ Improve loads

๐Ÿงช Demo

demo.mp4

โœ๏ธ Prerequisites

Make sure you have Docker and Docker Compose installed on your machine before proceeding.

๐Ÿ“ฆ Environment Variables

Change the file .env.template to .env.development :

# Database connection string:
DATABASE_URL=""

# Next-Auth config:
NEXTAUTH_SECRET="" # Generate a random string.
NEXTAUTH_URL="" # Your project url http://localhost:3000.

# Google OAuth Provider:
GOOGLE_CLIENT_ID=""
GOOGLE_CLIENT_SECRET=""

๐Ÿš€ Getting Started

Recommended extensions for VSCode:

  1. Clone or fork the repository:
git@github.com:danielcgilibert/OpenLink.git
  1. Install dependencies:
npm install
# or
yarn install
# or
pnpm install
  1. Run the following command to start the database:
docker-compose up
  1. Run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev

โ˜ Deploys

๐Ÿ”‘ License