diff --git a/README.md b/README.md index 3872eff..587ef3a 100644 --- a/README.md +++ b/README.md @@ -1 +1,119 @@ # Imagination-Django_Project- +
+Imagination + +
+ +### About: +A Poem Blogging website build with Django Framework. It is a fully mobile responsive website, with User login, Comment, Categories and Other Important Functionality like General CRUD Operations. + + +### Cloning the repository + +--> Clone the repository using the command below : +```bash +git clone https://github.com/SkSaadAli/Imagination_Django_Project_.git + +``` + +--> Move into the directory where we have the project files : +```bash +cd Imagination_Django_Project_ + + +``` + +--> Create a virtual environment : +```bash +# Let's install virtualenv first +pip install virtualenv + +# Then we will be creating our virtual environment +virtualenv envname + +``` + +--> Activate the virtual environment : +```bash +envname\scripts\activate + +``` + +--> Install the requirements : +```bash +pip install -r requirements.txt + +``` + +# + +### Running the App + +--> To run the App, we use : +```bash +python manage.py runserver + +``` + +> ⚠ Then, the development server will be started at http://127.0.0.1:8000/ + +# + +### Note + +--> update path to this directory for about.txt as path where your about.txt is saved +```bash + #keep in mind to change this directory for your file path + about = open('C:/Users/alisa/Desktop/ReadSomePoems/base/about.txt').read() + +``` + + + +# + +### App Preview : + + + + + + + + + + + +
+  +
+

+ Index/Home Page +

+ +
+
+

+ Poem Page Preview +

+ +
+  +
+ + +
+
+ + +
+ + + +
+
+

+ Login Page Preview +

+ +