Skip to content

Commit

Permalink
Initial /getting-started docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
pheralb committed Mar 24, 2024
1 parent 7a96bc3 commit da3ed8e
Showing 1 changed file with 49 additions and 3 deletions.
52 changes: 49 additions & 3 deletions src/app/docs/getting-started/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,56 @@ export const metadata = {
title: "Getting Started - Documentation",
};

### Introduction

Slug is a web application that offers to shorten urls in a simple, fast and secure way. It's built with [T3 Stack](https://create.t3.gg/), a web development stack made by [Theo](https://twitter.com/t3dotgg) focused on simplicity, modularity, and full-stack typesafety.

### Prerequisites

- 🍃 [Node.js LTS](https://nodejs.org/en/download/).
- 🧡 [pnpm v8](https://pnpm.io/installation).
- 🐈 A [GitHub](https://github.com/) account.
- 🔎 A [Google](https://www.google.com/) account.
- 💚 A [Turso](https://turso.tech/) account.
- ☁️ A [Vercel](https://vercel.com/) account.

### Getting Started

Welcome to the Slug documentation. This documentation is designed to help you get started with the project and provide you with the information you need to start contributing.
Follow these steps to self-host Slug:

1. **Clone the repository**:

```bash
git clone [email protected]:pheralb/slug.git
```

2. **Install the dependencies**:

```bash
npm install
```
pnpm install
```

3. **Set up environment variables**:

Create a `.env` file in the root of the project with the following content:

```bash
# Database:
DATABASE_URL= # By default: "file:./dev.db"
TURSO_DATABASE_URL=
TURSO_AUTH_TOKEN=

# Auth.js =>
AUTH_SECRET=
AUTH_URL=

# Github Provider =>
GITHUB_ID=
GITHUB_CLIENT_SECRET=

# Google Provider =>
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
```

Ready. In the next steps, you will setup the database and the authentication providers. ✨

0 comments on commit da3ed8e

Please sign in to comment.