https://github.com/rmodi6/accessible-forums
Web application for a forum website with accessibility
https://github.com/rmodi6/accessible-forums
elasticsearch flask flask-wtforms javascript jinja2-templates networkx-graph python python3 sqlalchemy wai-aria web-accessibility
Last synced: about 2 months ago
JSON representation
Web application for a forum website with accessibility
- Host: GitHub
- URL: https://github.com/rmodi6/accessible-forums
- Owner: rmodi6
- Created: 2020-09-03T20:02:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T16:47:19.000Z (9 months ago)
- Last Synced: 2025-01-11T08:08:55.020Z (3 months ago)
- Topics: elasticsearch, flask, flask-wtforms, javascript, jinja2-templates, networkx-graph, python, python3, sqlalchemy, wai-aria, web-accessibility
- Language: Python
- Homepage:
- Size: 167 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Accessible Forums
## Website
~~This app has been deployed to [Heroku](https://www.heroku.com/) and is available at: https://accessible-forums.herokuapp.com/.
For the best experience, do not use a mouse and use only the keyboard shortcuts along with a screen reader like NVDA or JAWS. If on a mobile device, use the appropriate accessibility tool based on your OS: Talkback on Android and VoiceOver on iOS.~~
>~~**Note:** There is no elasticsearch server connected to the Heroku app because of which fuzzy and fast search is disabled.~~
The website is down now as Heroku [no longer offers free Heroku Postgres server](https://blog.heroku.com/next-chapter).
## Development guide
>**Note:** Run all the commands in the project root directory
- Create a python 3 environment using your favorite environment manager. For example, conda users:
```bash
conda create -n accessible-forums python=3
```
- Activate the environment
```bash
conda activate accessible-forums
```
- Install all the dependencies using the requirements.txt file
```bash
pip install -r requirements.txt
```
- Initialize the database (uses the flask-migrate dependency)
```bash
flask db upgrade
```
- Before loading data into the database, copy the data files into the project root directory. The compressed data
directory can be downloaded [here](https://drive.google.com/uc?export=download&id=1grOjuzYedwTrJ3-GTQqkMpegPCc3aT4a).
```bash
cp -r /path/to/data/directory ./
```
- After copying, the project root directory should look like this:
```
📦accessible-forums
┣ 📂app
┣ 📂data
┃ ┣ 📜...csv files
┃ ┗ 📂folder (optional)
┃ ┗ 📜...csv files
┣ 📂migrations
┣ 📜.env
┣ 📜.gitignore
┣ 📜babel.cfg
┣ 📜config.py
┣ 📜main.py
┗ 📜requirements.txt
```
>**Note:** If you're going to use elasticsearch, now is a good time to start the elasticsearch server.
This will index the data into elasticsearch as we load them into db.
You can set the ip and port of the elasticsearch server in the `.env` file.
- Use the following command to load the data into database:
```bash
flask db-load
```
- Run the app using
```bash
flask run -h 0.0.0.0
```
By default, the app will be running on http://127.0.0.1:5000/.
On a local network (WiFi), you can access the website through any device on the same network (WiFi) using the local
ip address of the machine. E.g. If your machine has the local ip address 192.168.0.2, you can access the website using
http://192.168.0.2:5000/. Use the `ifconfig` command on UNIX machines and `ipconfig` command on Windows machines to get
the local ip address of the device.
## Credits
This project is heavily adopted from the excellent [Flask Mega-Tutorial by Miguel Grinberg](https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world).