|
1 | | -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). |
| 1 | +<div align="center"> |
| 2 | +<h1 align="center"> |
| 3 | +<img src="./public/assets/screenlink.svg" width="100" /> |
| 4 | +<br>ScreenLink Web</h1> |
2 | 5 |
|
3 | | -## Getting Started |
| 6 | +<p align="center"> |
| 7 | +<img src="https://img.shields.io/badge/Next.js-000000.svg?style=flat-square&logo=Next.js&logoColor=white" alt="Next.js" /> |
| 8 | +<img src="https://img.shields.io/badge/React-61DAFB.svg?style=flat-square&logo=React&logoColor=black" alt="React" /> |
| 9 | +<img src="https://img.shields.io/badge/TypeScript-3178C6.svg?style=flat-square&logo=TypeScript&logoColor=white" alt="TypeScript" /> |
| 10 | +<img src="https://img.shields.io/badge/Tailwind_CSS-38B2AC.svg?style=flat-square&logo=Tailwind-CSS&logoColor=white" alt="Tailwind CSS" /> |
| 11 | +<img src="https://img.shields.io/badge/Vercel-000000.svg?style=flat-square&logo=Vercel&logoColor=white" alt="Vercel" /> |
| 12 | +</p> |
4 | 13 |
|
5 | | -First, run the development server: |
| 14 | +<p align="center"> |
| 15 | +<a href="https://screenlink.io">Visit ScreenLink.io</a> |
| 16 | +</p> |
6 | 17 |
|
| 18 | +</div> |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +## π Table of Contents |
| 23 | + |
| 24 | +- [π Table of Contents](#-table-of-contents) |
| 25 | +- [π Overview](#-overview) |
| 26 | +- [π Getting Started](#-getting-started) |
| 27 | +- [π§ Installation](#-installation) |
| 28 | +- [π¦ Features](#-features) |
| 29 | +- [π€ Contributing](#-contributing) |
| 30 | + |
| 31 | +--- |
| 32 | + |
| 33 | +## π Overview |
| 34 | + |
| 35 | +ScreenLink Web is the web platform for ScreenLink, the open-source alternative to Loom for screen recording. It manages user accounts, video uploads, and serves as the landing page for new users. Built with Next.js, it leverages the best of React and server-side rendering for a fast and seamless user experience. |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +## π Getting Started |
| 40 | + |
| 41 | +To run the development server: |
7 | 42 | ```bash |
8 | | -npm run dev |
9 | | -# or |
10 | 43 | yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | 44 | ``` |
14 | 45 |
|
15 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
16 | 46 |
|
17 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 47 | +Visit [http://localhost:3000](http://localhost:3000) to view the application. |
18 | 48 |
|
19 | | -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. |
| 49 | +## π§ Installation |
20 | 50 |
|
21 | | -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. |
| 51 | +1. Clone the repository: |
| 52 | +```bash |
| 53 | +git clone https://github.com/mangledbottles/screenlink |
| 54 | +``` |
22 | 55 |
|
23 | | -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. |
24 | 56 |
|
25 | | -## Learn More |
| 57 | +2. Install dependencies: |
| 58 | +```bash |
| 59 | + cd screenlink/apps/web && yarn |
| 60 | +``` |
| 61 | + |
26 | 62 |
|
27 | | -To learn more about Next.js, take a look at the following resources: |
| 63 | +3. Start the development server: |
| 64 | +```bash |
| 65 | +yarn dev |
| 66 | +``` |
28 | 67 |
|
29 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
30 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
31 | 68 |
|
32 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! |
| 69 | +## π¦ Features |
33 | 70 |
|
34 | | -## Deploy on Vercel |
| 71 | +- **User Account Management:** Sign up, sign in, and manage user profiles. |
| 72 | +- **Video Uploads:** Upload and manage screen recordings. |
| 73 | +- **Landing Page:** Informational landing page for new users. |
35 | 74 |
|
36 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 75 | +## π€ Contributing |
37 | 76 |
|
38 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |
| 77 | +Contributions are welcome! Check out the [issues](https://github.com/mangledbottles/screenlink-web/issues) or submit a pull request. |
0 commit comments