diff --git a/src/app/docs/getting-started/page.mdx b/src/app/docs/getting-started/page.mdx index 1861355..7c498b0 100644 --- a/src/app/docs/getting-started/page.mdx +++ b/src/app/docs/getting-started/page.mdx @@ -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 git@github.com:pheralb/slug.git +``` + +2. **Install the dependencies**: ```bash -npm install -``` \ No newline at end of file +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. โœจ \ No newline at end of file