Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 3.14 KB

README.md

File metadata and controls

76 lines (56 loc) · 3.14 KB

image

Home · Sign Up

GitHub contributors License Commits-per-month

Athera is an open source blogging social network similar to Medium, Dev and HashNode. Users can create an share content on the platform

Feature Roadmap

  • Multiple languages
  • Analytics
  • Customization
  • Post Recommendations
  • AI Voiceovers
  • PWA support
  • Teams Support

Tech Stack

  • TypeScript - Language
  • Next.js - Framework
  • Tailwind CSS Sass PostCSS - CSS
  • Supabase - Database
  • Turborepo - Monorepo System
  • PNPM - Package Manager
  • Vercel - Deployment

Quick start

Before installing Athera, make sure your machine should have the following software installed:

  • Docker
  • NodeJS
  • Supabase CLI

Want to get up and running quickly? Follow these steps:
  1. Fork this repository to your GitHub account.

After forking the repository, clone it to your local device by using the following command:

git clone https://github.com/<your-username>/athera
  1. Run npm run db:start and copy the generated values into .env.example in the apps/web folder

    • This will spin up a postgres database and inbucket mailserver in a docker container.
  2. Rename .env.example to .env.test

  3. Run npm run dev:local in the root directory

Access Points for Your Application

  1. App - http://localhost:3000

  2. Incoming Mail Access - http://localhost:54324

  3. Database Connection Details

    • Port: 54320
    • Connection: Use your favorite database client to connect using the provided port.
  4. Supabase Dashboard - http://localhost:54323

License

This repository is available under the GNU Affero General Public License