Skip to content

Commit

Permalink
add README file
Browse files Browse the repository at this point in the history
  • Loading branch information
mohamedramadan14 committed Dec 4, 2023
1 parent 8a787d1 commit f739631
Showing 1 changed file with 14 additions and 21 deletions.
35 changes: 14 additions & 21 deletions ReadME.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Post Feature for Feed Feature 🥇
# Post Feature For Feed Feature (Social Media) 🥇

Simple implementation for Post Feature Where Users create accounts and confirm it via email confirmation.Users can create, read, update and delete posts.also users can like and unlike posts and comment on posts and edit and delete likes and comments.
Simple implementation of a social media post feature.Users can sign up and activate their account via confirmation email. They can then create posts, comment on them and like them.

## High-Level Design

![High-Level Design](./screenshots/post-feature-feed.drawio.png)

## Build Status

![Static Badge](https://img.shields.io/badge/Build_Status-Success-blue)
![Static Badge](https://img.shields.io/badge/Test_Coverage-95%25-green)
![Static Badge](https://img.shields.io/badge/Build_Status-Sucess-blue)
![Static Badge](https://img.shields.io/badge/Test_Coverage-94%25-dark_green)
![Static Badge](https://img.shields.io/badge/CI_CD-Included-dark_green)

## Monitoring with Sentry
Expand All @@ -24,31 +24,24 @@ Simple implementation for Post Feature Where Users create accounts and confirm i

Follow these steps to run the project offline:

1. **Clone the repository :**
```bash
1. Clone the repository:
```bash
git clone https://github.com/mohamedramadan14/news-feed-posts-feature.git
```

2. **Create Virtual Environment :**
2. Create Virtual Environment :
```bash
python -m venv venv
source venv/Scripts/activate [Windows]
#OR
source venv/bin/activate [Linux/Mac]
python -m venv venv
source venv/Scripts/activate [Windows]
# OR
source venv/bin/activate [Linux/Mac]
```

3. **Install Dependencies :**
3. Install Dependencies :
```bash
pip install -r requirements.txt
```

4. **Fill the .env file :**
4. Run the project :
```bash
cp .env.example .env
```

5. **Run the project :**
```bash
cd socialmedia
uvicorn main:app --reload
```
```

0 comments on commit f739631

Please sign in to comment.