CHA0sTIG3R commited on
Commit
01cd42b
1 Parent(s): 0b02540

Update README.md with project description and instructions

Browse files
Files changed (2) hide show
  1. .gitignore +15 -0
  2. README.md +1 -62
.gitignore ADDED
@@ -0,0 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ .pyc
6
+ .cpython-*
7
+ __pycache__
8
+
9
+
10
+ # environments
11
+ /env
12
+ /venv
13
+ /.venv
14
+ .env
15
+ /.env.*
README.md CHANGED
@@ -5,65 +5,4 @@ colorFrom: yellow
5
  colorTo: indigo
6
  sdk: docker
7
  pinned: false
8
- ---
9
-
10
- # AI Blog Writer
11
-
12
- AI Blog Writer is a web application that leverages artificial intelligence to help users generate blog posts on various topics
13
-
14
- ## Features
15
-
16
- - **Custom Blog Generation**: Users can input the topic, select the desired tone, specify length, and add any specific instructions to guide the content generation.
17
- - **Responsive Design**: Built with Bootstrap, the application is fully responsive and user-friendly, suitable for both desktop and mobile users.
18
- - **Dark Mode**: A sleek dark mode interface for comfortable usage in low-light conditions.
19
-
20
- ## Getting Started
21
-
22
- These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
23
-
24
- ### Prerequisites
25
-
26
- Before you begin, ensure you have the following installed:
27
-
28
- - Python 3.9 or later
29
- - Flask
30
- - OpenAI
31
- - OpenAI API key
32
-
33
- ### Installation
34
-
35
- 1. Clone the repository:
36
-
37
- ```bash
38
- git clone https://github.com/yourusername/ai-blog-writer.git
39
- ```
40
-
41
- 2. Navigate to the project directory:
42
-
43
- ```bash
44
- cd ai-blog-writer
45
- ```
46
-
47
- 3. Install the required Python packages:
48
-
49
- ```bash
50
- pip install -r requirements.txt
51
- ```
52
-
53
- 4. Run the Flask application:
54
-
55
- ```bash
56
- flask run
57
- ```
58
-
59
- The application should now be running on [http://localhost:5000](http://localhost:5000).
60
-
61
- ## Usage
62
-
63
- To use the application, simply navigate to the homepage, fill in the form with your blog post requirements, and click on the "Generate Blog Post" button. The AI will process your request and display a generated blog post based on your specifications.
64
-
65
- ## Built With
66
-
67
- - [Flask](https://flask.palletsprojects.com/) - The web framework used
68
- - [Bootstrap](https://getbootstrap.com/) - The front-end framework used for responsive design
69
- - [OpenAI API](https://openai.com/) - The AI model API for content generation
 
5
  colorTo: indigo
6
  sdk: docker
7
  pinned: false
8
+ ---