Skip to content

Latest commit

 

History

History
251 lines (176 loc) · 7.25 KB

README.md

File metadata and controls

251 lines (176 loc) · 7.25 KB
Raw

Contributors Forks Stargazers Issues LinkedIn


redlit

A social news aggregation website and discussion portal!
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgments

About The Project

An attempt to partially build a replica of reddit.

Architecture in detail's

    Functional Requirement

  1. Authentication Modal Login & SignUp
  2. TimeLineFeed from the People and the community you follow!
  3. TimeLine
  4. Create a Post
  5. Post: Title & Text Bos and submit
  6. Images & Videos : Upload

    7. On hold Features

  7. `Link` | `Poll` | `Talk with mic`

State Management:

  • Local State : useState()
  • Global state : Recoil
  • server state : ?
  • URL state : Nextjs [useRouter()]

Firestore : a document reference, creating a community

  • Database: users & community

  • users can join many community

  • community can have many users | Many to Many relation

  • Atomic Operations: Firestore supports atomic ops to read and write data. 2 types : Transactional & Batched Writes.

  • Transactional : a set of read & write operations on one or more documents.

  • Batched Writes : a set of write operations on one or more documents.

Votes on Posts : The most fun part of this project.

  • UpVote or DownVote
  • voting function's : upvote ,downvote , removing the Vote (upvote => neutral or downvote => neutral) and Flipping the Vote (up => down or down => up)

Non-Functional Requirements
  • High Availability People Feed
  • Latency
  • Scale
  • Fault tolerant

    • (back to top)

    Home

    Built With

    • Nextjs

    • React

    (back to top)

    Getting Started

    Instructions on setting up this project locally. To get a local copy up and running follow these simple example steps.

    Prerequisites

    How to use the software and how to install them.

    • npm 
      npm install npm@latest -g

    Installation

    1. Setup a webapp in firebase DB
    2. Clone the repo 
      git clone https://github.com/roshray/redlit.git
    3. Install NPM packages 
      npm install
    4. Enter your Firebase API in .env 
      NEXT_PUBLIC_FIREBASE_API_KEY = "enterYoUrkEy",
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN = "",
NEXT_PUBLIC_FIREBASE_PROJECT_ID = "",
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET = "",
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID = "",
NEXT_PUBLIC_FIREBASE_APP_ID = ""

    (back to top)

    Usage

    Additional screenshots, code examples and demos are shared.

    For more details, please refer to the Documentation

    (back to top)

    Roadmap

    • Authentication as loggedIn & LoggedOut.
    • Create Community,Post.
    • Display the Post on the Feed.
      • comment,vote and delete post.

    See the open issues for a full list of proposed features (and known issues).

    (back to top)

    Contributing

    Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

    If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

    1. Fork the Project
    2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
    3. Commit your Changes (git commit -m 'Add some AmazingFeature')
    4. Push to the Branch (git push origin feature/AmazingFeature)
    5. Open a Pull Request

    (back to top)

    Contact

    Roshan Ray - @rosh_ray_ - [email protected]

    Project Link: https://github.com/roshray/redlit

    (back to top)

    Acknowledgments

    (back to top)