Post Feed

Web app to share your breathtaking stories
--> Quick start <--

Table of Contents

1. Features
2. Getting Started
   • Run as python script
   • Secrets
3. Explanations
4. Restrictions
5. Planned updates
6. Contact

Features

• Adding your amazing stories to feed and show them for other users.
• Editing your post if you want to make it perfect.
• Watching other users' posts.
• Adding your posts to thematic groups.

Built With

Getting Started

Run as python script

Prerequisites

• python 3.9.19
• pip

Installation

1. Clone the repo

   $ git clone https://github.com/Alexandr-Safariantc/post_feed

2. Activate virtual environment

   $ cd post_feed
   $ python3 -m venv venv

• for Linux/macOS

  $ source .venv/bin/activate

• for windows

  $ source .venv/scripts/activate

3. Upgrade pip

   (venv) $ python3 -m pip install --upgrade pip

4. Install requirements

   (venv) $ pip install -r requirements.txt

5. Migrate database

   (venv) $ alembic upgrade head

6. Add test data to database

   (venv) $ python3 cli.py test-data

7. Run app

   (venv) $ uvicorn main:app --reload

8. Get API documentation

   http://127.0.0.1:8000/docs

(back to top)

Secrets

.env secrets

SECRET_KEY: key for user password encoding.

(back to top)

Explanation

Database Structure

User
Contains creation date, user data.

Group
Contains creation date, description, slug, title.

Post
Contains post author, post group, publication date, text, title.

Restrictions

1. Groups for superusers
We know that you have lots of brilliant ideas for thematic post groups but we have to save resources to ensure all your wonderful posts are featured in our feed.

2. Titles are required
We really want to meet your expectations so to make it easier and faster to find exciting post you have to add title to your post.

(back to top)

Planned updates

1. Comments
We really appreciate your opinion and we want you to have opportunity to express it, so we are going to add a post commenting feature.

2. Subscriptions
We know that you have found your favorite authors in our post feed and we want you to receive their posts first, new author subscription feature will help you.

(back to top)

Contacts

Alexandr Safariants Backend developer

(back to top)