Skip to content

MarwanRadwan7/fleet

Repository files navigation

Fleet

Version Stargazers MIT License

Fleet is a social media application to share your thoughts, make new fiends and text with your friends

Docs

  • API Documentation: list of the application 's backend endpoints.
  • Database Schema: Database Design of the app and it also available in .dbml format.
  • App is Built With:

    • TypeScript
    • NestJS
    • PostgreSQL
    • TypeORM
    • Redis Caching
    • SocketIO
    • Cloudinary

Features

  • App comes with following features:
    • Protected endpoints either the REST or WebSockets with JWT Tokens.
    • Cached Responses for better performance.
    • Exceptions and Error handling.
    • RateLimiting for the endpoints.
    • SQL Injection and CORS protection.
  • Users can do the following:
    • Posting with the ability to attach media to the posts.
    • Find the posts with hashtags they are interested in.
    • Comment and like other user's posts.
    • Follow other users amd block unwanted users.
    • Create public chat groups.
    • Chat in public groups or with other users privately.
    • Get a feed of posts either from their following users or get the top trending posts based on the overall interactions.

Installation

$ npm install

Running the app

The .env file should have these environment variables similar to the example.env

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

License

Fleet is MIT licensed.