https://github.com/bibeklakra91/newsflash
Webapp for quick personal updates, just like tweeter. Basic full-stack app to understand the fundamentals. Tech stack: [ Django, AWS s3, Vercel, PostgreSQL + Railway ]
https://github.com/bibeklakra91/newsflash
aws-s3 django postgresql vercel
Last synced: 2 months ago
JSON representation
Webapp for quick personal updates, just like tweeter. Basic full-stack app to understand the fundamentals. Tech stack: [ Django, AWS s3, Vercel, PostgreSQL + Railway ]
- Host: GitHub
- URL: https://github.com/bibeklakra91/newsflash
- Owner: BibekLakra91
- License: mit
- Created: 2024-07-04T10:16:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T18:20:28.000Z (almost 2 years ago)
- Last Synced: 2025-05-17T04:35:13.899Z (about 1 year ago)
- Topics: aws-s3, django, postgresql, vercel
- Language: JavaScript
- Homepage: https://news-flash-five.vercel.app/
- Size: 1.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NewsFlash/__init__.py
- License: LICENSE
Awesome Lists containing this project
README
# NewsFlash
NewsFlash is a web application for quick personal updates, similar to Twitter. It is designed to help users understand the fundamentals of a full-stack application. I have added challenges I faced as well as bullet points for resume as well
## Tech Stack
- **Backend:** Django
- **Frontend:** HTML, CSS templates & Boostraped code
- **Database:** PostgreSQL
- **Hosting:** Vercel, AWS S3, Railway
## Features
- Post personal updates
- View updates from other users
- Media storage with AWS S3
- Deployed on Vercel with PostgreSQL database managed by Railway
## Getting Started
### Installation
1. Clone the repository:
```bash
git clone https://github.com/BibekLakra91/NewsFlash.git
cd NewsFlash
```
2. Install dependencies:
```
pip install -r requirements.txt
```
```
pip install psycopg2
```
Vercel absolutely hate psycopg2, I have not added this to requirements.txt but it is necessary to run on local server. Remove this package before creating PRs
3. Create .env file and populate these fields
```
AWS_ACCESS_KEY_ID =
AWS_SECRET_ACCESS_KEY =
AWS_STORAGE_BUCKET_NAME =
AWS_S3_REGION_NAME =
DB_NAME =
DB_USER =
DB_PASSWORD =
DB_HOST =
DB_PORT =
```
3. Set up the database:
```bash
python manage.py migrate
```
4. Run the server:
```bash
python manage.py runserver
```
5. Open your browser and go to `http://127.0.0.1:8000/`
## Contributing
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Open a pull request.