Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.18 KB

README.md

File metadata and controls

58 lines (42 loc) · 2.18 KB
Raw

Social app

This is a social media web app that I am working on to develop my full-stack skills.

How to use

From web

Visit https://social.stevon.dev/

From source

  1. Clone the repository using git clone git@github.com:TeenageMutantCoder/sw-social-app.git or git clone https://github.com/TeenageMutantCoder/sw-social-app
  2. Change to the repository directory using cd sw-social-app
  3. Make a copy of env.example and rename it to .env using cp env.example .env (if using a Unix-based system) or copy env.example .env (if using Windows)
  4. For the easiest setup, update the db provider (line 9) in prisma\schema.prisma to be "sqlite". Otherwise, edit the DATABASE_URL in your .env file to be the connection string for your PostgreSQL database
  5. Install needed dependencies with npm install
  6. Create/update database with npx prisma db push
  7. Run the development server using npm run dev

Tech stack

This project was bootstrapped using create-t3-app. That means that the main technologies used are:

I also included some other helpful libraries such as React Hook Form.

MVP

Here are the features that I will definitely add:

  • Name-based user auth (simpler to add and to use, at least for a portfolio project that is not meant to be a production app)
  • Post (text) creation, editing, and deletion
  • Likes on posts and comments
  • Comments (text) on posts (creation, editing, deleting)

Future Improvements

Here are other things that I may add in the future:

  • Algorithm for displaying new content
  • More sophisticated user auth
  • Friends list
  • Direct private messaging
  • Increased profile customization
  • Search for posts/comments/users
  • Save a user's favorite posts/comments
  • Block users
  • Multimedia posts
  • Multimedia comments
  • Rich-text support
  • etc.