- Run
pip install -r requirements.txt
to install all dependencies written inrequirements.txt
.
python3 app.py
in backened It will start the flask app indevelopment
. This is for running app on local system.npm run serve
in frontend for serving the app from frontend on Vue.~/go/bin/MailHog
for starting mailhog on local server.celery -A app.celery worker -l info
in backened to start the celery workers.celery -A app.celery beat --max-interval 1 -l info
in backened to start the celery beat and scheduler.redis-cli
to start the redis server in terminal.
backened
andfrontend
folders, which will be described next.Project Documentation
having a brief description about app- Have an
yaml
file as api documentation. Project Documentation
having a brief description about app- A
readme
file andrequirements
file
project.sqlite3
is the sqlite database. It can be anywhere on the machine, just the adjustment in the path inapp.py
is required. One of the database is shipped for testing.- The application code for my app is
/
templates
is the default folder where templates are stored which is used for sending mails.- It also have
api.py
,cache.py
,cachingdata.py
,clery.py
,emailgenr.py
,models.py
andtasks.py
folders, which cointains all apis, caching initialization, caching, celery initialization, email generation, backend tasks like reminders export etc. respectively. static
a folder in which we have csv files of exported data.
node_modules
required for running VueJS CLIpublic
having public componentsassets
having public necessary images and two other foldersblogs
andprofile
both having user uploaded blog image and uploaded profile image respectively.src
is the default folder where frontend components and routers are located.components
which has vue components for frontend,router
which containsindex.js
for defining different routes,App.vue
the page on which app is being served,index.js
for app start andstore
to create the store for vue.- A
readme
file and other required configurations.
mad2-project
├── backend
| ├── app.py
| ├── api.py
| ├── cache.py
| ├── cachingdata.py
| ├── clery.py
| ├── database.sqlite3
| ├── emailgenr.py
| ├── models.py
| ├── tasks.py
| ├── templates
| | ├── blogs_csv.html
| | ├── daily_reminder.html
| | └── monthly_report.html
| └── Static
|
├── frontend/
│ ├── public
| ├──src
| | ├── assets
| | | ├── Blogs
| | | └── Profile
| | ├── components
| | | ├── CommentBlog.vue
| | | ├── EditBlog.vue
| | | ├── EditProfile.vue
| | | ├── LoginSignup.vue
| | | ├── MyFollowers.vue
| | | ├── MyFollowing.vue
| | | ├── NavBar.vue
| | | ├── PostBlog.vue
| | | ├── PostEngage.vue
| | | ├── ReadBlog.vue
| | | ├── SPage.vue
| | | ├── StartPage.vue
| | | └── UserProfile.vue
| | ├── router/index.js
| | ├── store/inex.js
| | ├── App.vue
| | └── main.js
| ├── .gitignore
| ├── babel.config.js
| ├── jsconfig.json
| ├── package-lock.json
| ├── package.json
| ├── README.md
| └── vue.config.js
├── Bloglite.yaml
├── requirements.txt
├── Project_Report_ BLOG-LITEV2.pdf
└── readme.md