README.md

ReadiumX

Screen.Recording.2024-07-20.at.4.27.48.PM.mov

ReadiumX

The open-source tool that provides access to premium Medium articles without the paywall
Learn more »

Introduction · Features · Tech Stack · Contributing

Introduction

ReadiumX is an open source tool that provides access to premium Medium articles without the paywall, allowing you to bookmark, and manage your reading experience across any device

Tech Stack

• Next.js – framework
• TypeScript – language
• Tailwind – CSS
• TursoDB – database
• Lucia Auth – auth
• Resend – emails
• DrizzleORM – ORM
• TipTap – editor
• Shadcn – component library
• Railway – deployments

Features

• Access Premium Articles: Bypass paywalls to access content freely.
• Bookmarking System: Save your favorite articles for later reading.
• Progress Tracking: Automatically saves your reading progress to resume where you left off.
• Reading History Management: View and manage your reading history with options to delete records.

Running Locally

1. Clone the repository

   git clone https://github.com/JaleelB/readium-x.git

2. Install dependencies using pnpm

   pnpm install

3. Copy the .env.example to .env and update the variables.

   cp .env.example .env

4. Start the development server

   pnpm run dev

5. Push the database schema

   pnpm run db:push

Setting up Google Provider

If you want google login, you'll need to setup a google project and create some keys:

1. https://console.cloud.google.com/apis/credentials
2. create a new project
3. setup oauth consent screen
4. create credentials - oauth client id
5. for authorized javascript origins

• http://localhost:3000
• https://your-domain.com

6. Authorized redirect URIs

• http://localhost:3000/api/login/google/callback
• https://your-domain.com/api/login/google/callback

7. Set your google id and secret inside of .env

• GOOGLE_CLIENT_ID
• GOOGLE_CLIENT_SECRET

Setting up Github Provider

If you want github login, you'll need to setup a github project and create some keys:

1. https://github.com/settings/developers
2. Create a new OAuth App
3. Create an application for the for local development:
   • Homepage URL: http://localhost:3000
   • Authorization callback URL: http://localhost:3000/api/login/github/callback
4. Create an application for the for production:
   • Homepage URL: https://your-domain.com
   • Authorization callback URL: https://your-domain.com/api/login/github/callback

Contributing

Contributions are welcome! Please open an issue if you have any questions or suggestions. Your contributions will be acknowledged. See the contributing guide for more information.

License

Licensed under the MIT License. Check the LICENSE file for details.