Skip to content

danielcgilibert/OpenLink

Repository files navigation

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