|
2 | 2 | [](https://github.com/gordienkoas/python-project-83/actions) |
3 | 3 | [](https://github.com/gordienkoas/python-project-83/actions/workflows/python-app.yaml) |
4 | 4 |
|
| 5 | +## Page Analyzer. Hexlet.io School's third project. |
| 6 | + |
| 7 | +Page Analyzer is a Flask web application that allows users to analyze web pages for SEO effectiveness. The application checks the availability of websites and analyzes elements such as headers, descriptions, and H1 tags. |
| 8 | + |
| 9 | +## Features |
| 10 | + |
| 11 | +- URL availability check. |
| 12 | +- Analysis of title and description tags. |
| 13 | +- Display of check results on the user interface. |
| 14 | + |
| 15 | +## Demo |
| 16 | + |
| 17 | +You can view the application in action at this link: |
| 18 | +[python-project-83-i26e.onrender.com]https://python-project-83-i26e.onrender.com |
| 19 | + |
| 20 | +## Technologies |
| 21 | + |
| 22 | +- Python |
| 23 | +- Flask |
| 24 | +- PostgreSQL |
| 25 | +- HTML/CSS |
| 26 | +- Bootstrap for frontend |
| 27 | +- Poetry for dependency management |
| 28 | + |
| 29 | +## Getting Started |
| 30 | + |
| 31 | +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. |
| 32 | + |
| 33 | +### Prerequisites |
| 34 | + |
| 35 | +Ensure you have Python, Poetry, and PostgreSQL installed. |
| 36 | + |
| 37 | +### Installation and Running |
| 38 | + |
| 39 | +Use the `Makefile` to simplify the installation and startup process: |
| 40 | + |
| 41 | +```bash |
| 42 | +git clone https://github.com/gordienkoas/python-project-83 |
| 43 | +cd python-project-83 |
| 44 | + |
| 45 | +## Configuration |
| 46 | +Before running the application, make sure your environment variables are set up correctly. Check the .env file and ensure that it contains valid values for the following variables: |
| 47 | +SECRET_KEY: A secret key for your application. |
| 48 | +DATABASE_URL: The connection string for your PostgreSQL database, formatted as postgresql://username:password@localhost:5432/database_name. |
| 49 | + |
| 50 | +# Install dependencies |
| 51 | +make install |
| 52 | + |
| 53 | +# Run the local development server |
| 54 | +make dev |
| 55 | + |
| 56 | +# Run the production server |
| 57 | +make start |
| 58 | +``` |
| 59 | + |
| 60 | +### Testing |
| 61 | + |
| 62 | +To run tests, use the following command: |
| 63 | + |
| 64 | +```bash |
| 65 | +make lint # Code linting |
| 66 | +``` |
0 commit comments