An open API service indexing awesome lists of open source software.

https://github.com/danielc92/flask_robot_forum

Flask web application forum filled in with fictional robot characters
https://github.com/danielc92/flask_robot_forum

Last synced: 2 months ago
JSON representation

Flask web application forum filled in with fictional robot characters

Awesome Lists containing this project

README

          

# Robot Forum
A forum built in `flask` and `bulma` using fictional data.

# Process
1. Generate dummy data for the application.
2. Push dummy data into `sqlite3` database file.
3. Test interactions between application and database file.
4. Assign avatar images using `robohash` site.
5. Create a master template (`base.html`) which other pages will be generated from (members, threads etc).
6. Google fonts/Bulma to be used for styling the application.
7. Code in routes for custom pages.
8. Add bi-directional links within routes.
9. Test routes and make sure they work as intended.
10. Deploy to heroku and test.

# Meta Data
**robots**
- robot_id
- robot_name
- robot_age
- robot_joined

**threads**
- thread_robot_id
- thread_id
- thread_name
- thread_content
- thread_stars
- thread_tags
- thread_date

**comments**
- comment_thread_id
- comment_id
- comment_content
- comment_date
- comment_thumbs_down
- comment_thumbs_up

# Before you get started
Concepts you should be familiar with before starting;
- web applications
- databases/orm
- https/requests
- flask
- python

# Setup
**How to obtain this repository:**
```sh
git clone https://github.com/danielc92/flask_robot_forum.git
```
**Modules/dependencies:**
- `pandas`
- `flask`
- `flask-sqlalchemy`
- `bulma` css framework

Install the following dependences:
```sh
pip install pandas flask flask-sqlalchemy
```

# Tests
- Tested function to return robot text for threads and comments using this [generator](http://carterschieffer.com/hello-robot)
- Generated dummy data for `robots`, `threads` and `comments` tables to `forum-data` subdirectory.
- Pushed dummy data .csv files into sqlite.db file succesfully
- Mapped each table from database to flask application using flask-sqlalchemy
- Tested pushing query result into render template for loop

# Contributors
- Daniel Corcoran

# Sources
- [Robohash - Avatar generator](https://robohash.org/)
- [Flask-SQLAlchemy documentation](http://flask-sqlalchemy.pocoo.org/2.3/)
- [Flask documentation](http://flask.pocoo.org/docs/1.0/)
- [Bulma CSS framework](https://bulma.io/documentation/overview/start/)
- [Heroku (paas)](https://www.heroku.com/)
- [Hello Robot - text generator](http://carterschieffer.com/hello-robot/)