https://github.com/aleandropresta/articles-webapp
A web app built in Django and Bootstrap that allows the user to sign in, log in and add new posts
https://github.com/aleandropresta/articles-webapp
django python sqlite3 webapp
Last synced: about 1 month ago
JSON representation
A web app built in Django and Bootstrap that allows the user to sign in, log in and add new posts
- Host: GitHub
- URL: https://github.com/aleandropresta/articles-webapp
- Owner: AleandroPresta
- Created: 2024-06-10T13:16:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T10:23:31.000Z (almost 2 years ago)
- Last Synced: 2025-02-02T11:29:14.630Z (over 1 year ago)
- Topics: django, python, sqlite3, webapp
- Language: Python
- Homepage:
- Size: 11.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Articles Webapp
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
## Overview
`articles-webapp` is a web application built using Django, a high-level Python web framework, and Bootstrap, a front-end framework for developing responsive and mobile-first websites. This application allows users to sign up, log in, and publish new posts, making it an ideal platform for sharing articles, blogs, or any form of written content.
## Features
- **User Authentication**: Supports user registration, login, and logout functionalities.
- **Article Management**: Users can add new posts, edit their existing posts, and delete them.
- **Responsive Design**: Utilizes Bootstrap to ensure the web app is accessible and provides a seamless experience across various devices and screen sizes.
## Prerequisites
Before you begin, ensure you have the following installed on your system:
- Python (version 3.6 or newer)
- pip (Python package installer)
## Installation
1. **Clone the Repository**
```bash
git clone https://github.com/yourusername/articles-webapp.git
cd articles-webapp
```
2. **Set Up a Virtual Environment (Optional but recommended)
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. **Install Dependencies**
```bash
pip install -r requirements.txt
```
4. **Database Migrations**
Apply database migrations to set up the necessary database schema:
```bash
python manage.py migrate
```
5. **Run the Development Server**
Start the Django development server:
```bash
python manage.py runserver
```
Visit `http://127.0.0.1:8000/` in your web browser to view the application.
## Usage
- **Sign Up**: Navigate to the sign-up page to create a new user account.
- **Log In**: Log in with your user credentials to access the application.
- **Add New Post**: Once logged in, you can add new posts by navigating to the appropriate section in the application.
- **Navigate Posts**: Navigate all the posts in the site, using the search and filter functionality to make the reserch easier.
- **Edit and delete your posts**: Edit and delete posts that you have created from your profile.
- **Update your profile**: Update your profile picture, bio, address and phone number.
- **User Profile**: Visit other people's profiles and see their informations and their posts.
- **Articles and Comments**: Read the full articles and leave comments.
## Contributing
Contributions to `articles-webapp` are welcome! Please follow the standard fork-and-pull request workflow. If you plan on adding a new feature or fixing a bug, please open an issue first to discuss your ideas.