/connecting-api

Backend for a simple picture based social network featuring likes, followers, comments and hashtags functionality. Images are automatically resized and stored in a AWS S3 bucket.

Primary LanguageJavaScript

connecting-api

output.mp4

Backend for a simple picture based social network featuring likes, followers, comments and hashtags functionality. Images are automatically resized to a pre-configured resolution — blurred inline margins are generated, if necessary — and stored in a AWS S3 bucket.

Usage

  1. Setup an PostgreSQL database and an AWS S3 bucket
  2. Create a .env file from .env.example and fill out the values corresponding to the created database and bucket
  3. Install the dependencies with 
    $ npm install
  4. Run the migrations with 
    $ npm run migrate up
  5. Run the development server with 
    $ npm run dev

Roadmap

  • Auth
    • Access and refresh token authentication
    • Role based authentication
    • Github authentication
    • Password reset
  • Users
    • Profile update
  • Posts
    • Post creation
    • Post deletion
  • Upvote system
  • Followers system
  • Comments system
  • Hashtags system
  • Documentation
  • Tests