This repository is dedicated to the CITS5505 group project, which developed a request forum called 'Askify'.
Askify enables users to create their own communities and posts with text and pictures, as well as reply to, like/unlike, save/unsave any post they choose.
Additionally, Askify allows users to manage their profiles, including changing their avatar, username, email, and password. Users can also track their activity on the platform, viewing the posts they have created, replied to, or saved.
Moreover, Askify provides a full-text search feature to find any community or post you are looking for. You can search using the title, content, or author to get the results you want.
Askify ensures your protection by offering industry-standard authentication mechanisms, and all APIs on the platform are secure. You don't need to worry about your data or privacy being compromised.
You can quickly access the platform using your Google or GitHub account, or you can register a new account to start enjoying Askify.
ASKIFY, UNLOCKING KNOWLEDGE.
There are two ways to get started; you can choose either way you prefer.
You can clone the repo and set it up by following these steps:
Use https://github.com/tonglam/CITS5505_group-project.git to clone the repo to your machine.
Create a virtual environment (venv) for the project. Using VSCode as an example:
- Use the shortcut
Cmd + Shift + Pto access VSCode commands. - Select
> Python: Select Interpreter. - Click on
Create Virtual Environment - Venv. - Use the shortcut
Cmd + Jto open the terminal. - If the terminal command line starts with
(.venv), you're in the virtual environment.
Use requirements.txt to install the necessary libraries.
pip install -r requirements.txtUse the config.ini.example as a template to create a config.dev.ini file or config.prod.ini file, which will be used in the dev or prod environment accordingly.
If you only want to run it under dev environment, all you need is to create a config.dev.ini file under root directory.
Replace the following keys to start the Flask app with the minimum configuration.
[APP]
SECRET_KEY = example-key
JWT_SECRET_KEY = jwt-example-key
[SQLITE]
DATABASE_URL = sqlite:///example.dev.sqlite
- Replace the following keys using your own Google OAuth token and Github OAuth token, to use Google/Github authentication.
[GOOGLE]
CLIENT_ID = example_id
CLIENT_SECRET = example_secret
CALLBACK_URL = http://127.0.0.1:5000/auth/callback/google
[GITHUB]
CLIENT_ID = example_id
CLIENT_SECRET = example_secret
CALLBACK_URL = http://127.0.0.1:5000/auth/callback/github
- Replace the following keys using your ImageBB Api key to use upload picture service.
[IMGBB]
API_KEY = example_key
# using command line
export FLASK_ENV=dev # load config.dev.ini
export FLASK_ENV=prod # load config.prod.iniThe app runs on http://127.0.0.1:5000. And the default env is dev.
flask run
# or run in debug mode
flask run --debugA simpler way to enjoy Ask is to use our Docker image.
Start the Docker daemon, such as Docker Desktop, on your local machine or server.
Execute the following command in the terminal.
# run docker container
docker-compose -f docker-compose.dev.yml up
# run docker container in background
docker-compose -f docker-compose.dev.yml up -d
# stop docer container
docker-compose -f docker-compose.dev.yml downAlternatively, if you want to run Docker directly:
docker run -p 5000:5000 tonglam/cits5505_group-project:lastest
docker run -d -p 5000:5000 tonglam/cits5505_group-project:lastestThe Askify project has two kinds of tests: unit tests and end-to-end tests using Selenium. We provide an easy way to run these tests.
The test.py file is located in the root directory.
To run all the unit tests, execute the following command in the terminal:
python test.pyIf you want to run unit tests for a specific module, use the following command:
python test.py [api|auth|community|popular|post|search|user]To run the Selenium end-to-end tests, execute the following command in the terminal:
python test.py end2endThe Auth module provides services for registering, logging in, and resetting forgotten passwords.
The Api module integrates all the APIs of Askify, and all endpoints are protected by JWT.
The Community module provides services for adding, editing, deleting, and viewing communities.
The Job module contains scheduled jobs.
The Notice module uses the observer design pattern to implement a publish-subscribe mechanism for notifications.
The Popular module provides services for displaying trending posts and communities.
The Post module provides services for adding, editing, deleting, and viewing posts and replies.
The Search module provides services for full-text search.
The User module provides services for displaying, editing user profiles, and tracing user behaviors on the platform.
- Flask for creating the web server.
- Jinja2 for rendering the templates.
- SQLite for database.
- Bootstrap for frontend UI.
- JavaScript and jQuery for DOM manipulation and Ajax.
- Flask-Login for user session management.
- Flask-SQLAlchemy and Flask-Migrate for SQLite database - management.
- Flask-WTF for form validation.
- Flask-JWT-Extended for implementing JWT for APIs.
- flasgger for creating Swagger documentation.
- Flask-APScheduler for implementing scheduled jobs.
- flask-unittest for integrating unit tests and selenium tests.
If you encounter any issues when using Askify, you can look into the Wiki for this repo. It may contain useful information, as we maintain the documentation throughout the development process.
The main branch is used for deploying to production. Visit Here
We also use Swagger (Flasgger) for API documentation in this project. Visit Here.