Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bouzayenilyes/swiftdocs
SwiftDocs is a streamlined, AI-powered document management system designed to optimize how users organize, store, and retrieve documents efficiently. Built with modern web technologies, it offers a clean and intuitive interface for enhanced productivity.
https://github.com/bouzayenilyes/swiftdocs
clerkauth framer-motion liveblocks nextjs reactjs tailwindcss
Last synced: 18 days ago
JSON representation
SwiftDocs is a streamlined, AI-powered document management system designed to optimize how users organize, store, and retrieve documents efficiently. Built with modern web technologies, it offers a clean and intuitive interface for enhanced productivity.
- Host: GitHub
- URL: https://github.com/bouzayenilyes/swiftdocs
- Owner: bouzayenilyes
- Created: 2024-12-03T19:18:51.000Z (20 days ago)
- Default Branch: main
- Last Pushed: 2024-12-03T20:17:55.000Z (20 days ago)
- Last Synced: 2024-12-03T20:31:27.722Z (20 days ago)
- Topics: clerkauth, framer-motion, liveblocks, nextjs, reactjs, tailwindcss
- Language: TypeScript
- Homepage: https://theswiftdocs.vercel.app
- Size: 715 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Follow these steps to set up the project locally on your machine.
**Prerequisites**
Make sure you have the following installed on your machine:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/) (Node Package Manager)
**Cloning the Repository**
```bash
git clone https://github.com/bouzayenilyes/swiftdocs.git
cd swiftdocs
```
**Installation**
Install the project dependencies using npm:
```bash
npm install
```
**Set Up Environment Variables**
Create a new file named `.env` in the root of your project and add the following content:
```env
#Clerk
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
#Liveblocks
NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY=
LIVEBLOCKS_SECRET_KEY=
```
Replace the placeholder values with your actual Clerk & LiveBlocks credentials. You can obtain these credentials by signing up on the [Clerk](https://clerk.com/) and [Liveblocks](liveblocks.io/) website.
**Running the Project**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.