NexCrow

Welcome to NexCrow, a social networking platform that allows users to share their thoughts, memories, and interact with a vibrant community. Inspired by the dynamics of social connectivity, NexCrow provides a space for individuals to express themselves, connect with others, and explore a world of content.

Table of Contents

• Installation
• Setup
• Usage
• Features
• Technologies Used
• Project Structure
• Contact

Installation

To get started with NexCrow, ensure you have Python, pip, and a virtual environment manager like virtualenv or conda installed.

1. Clone the repository:

   git clone https://github.com/zilogfa/Crow-Nexus.git
   cd NexCrow
   

2. Create and activate a virtual environment: (bash)

   virtualenv venv
   source venv/bin/activate # On Windows use `venv\Scripts\activate`
   

3. nstall the required packages:

   pip install -r requirements.txt

Setup

1. Set up the configuration in config.py, ensure to configure the database URI and other environment variables.
2. Run database migrations:

flask db upgrade

3. Start the application: flask run

4. Visit http://127.0.0.1:5000/ in your web browser.

Usage

• Home Page: View posts from followed users, and create new posts.
• Explore Page: View all public posts from all users.
• Profile Page: View and edit your user profile.
• Post Page: Comment on post.
• Analysis: Detailed reports of how users interact with your content.
• Search: Search for other users.
• Setting Page: Edit your information and change profile and header images.
• Login Page
• Register Page
• Alerts and Notifications Page.
• About Page

Features

• User authentication and profiles.
• Posting text and images.
• Liking posts and comments.
• Commenting on posts.
• Following and unfollowing users.
• Post Impressions & Engagement Analysis.

Technologies Used

• Backend: Python, Flask, SQLAlchemy, WTForms
• Frontend: HTML, CSS, JavaScript, Ajax
• Database: SQLite/PostgreSQL
• Deployment: Heroku

Project Structure

Below is the filesystem blueprint for the NexCrow Flask Social Media platform:

NexCrow/
├── app/
│ ├── forms/
│ │ ├── init.py
│ │ └── main_forms.py
│ ├── models/
│ │ ├── init.py
│ │ └── user.py
│ ├── routes/
│ │ ├── init.py
│ │ └── main_routes.py
│ ├── static/
│ │ ├── css/
│ │ ├── images/
│ │ ├── post_pictures/
│ │ ├── profile_pictures/
│ │ ├── header_pictures/
│ │ └── js/
│ ├── templates/
│ └── init.py
├── instance/
├── .gitignore
├── config.py
├── Procfile
├── README.md
├── requirements.txt
└── run.py

• app/: Contains the main application package.
• forms/: Holds form classes for user input.
• models/: Contains ORM models.
• routes/: Defines the routes of the web application.
• static/: Stores static files like CSS, JavaScript, and image assets.
• templates/: Contains the HTML templates for the application.
• instance/: A folder for instance-specific configurations (not tracked by git).
• config.py: Configuration variables for the Flask app.
• Procfile: Used for declaring what commands are run by the application on startup (Heroku specific).
• requirements.txt: Lists all the Python dependencies.
• run.py: The entry point to start the Flask server.

Each directory has an __init__.py file to make it a package and potentially include package-level documentation or configuration.

Contact

• Developer: Ali Jafarbeglou - zilogfa@live.com - https://alijafarbeglou.com
• For any inquiries or issues, please contact