https://github.com/el634dev/zensphere
Supportive chatroom to help improve mental health
https://github.com/el634dev/zensphere
css3 flask-sqlalchemy html-bootstrap socket-io
Last synced: 3 months ago
JSON representation
Supportive chatroom to help improve mental health
- Host: GitHub
- URL: https://github.com/el634dev/zensphere
- Owner: el634dev
- License: apache-2.0
- Created: 2024-01-05T00:10:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-12T21:32:07.000Z (over 1 year ago)
- Last Synced: 2025-01-30T10:30:29.650Z (4 months ago)
- Topics: css3, flask-sqlalchemy, html-bootstrap, socket-io
- Language: HTML
- Homepage:
- Size: 203 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZenSphere
> Supportive chatroom that is geared towards creating supportive communities to improve mental health.
>
[](https://www.python.org/)
[](http://ansicolortags.readthedocs.io/?badge=latest)# Quickstart/Demo
> Live demo [_here_](https://www.example.com).## Table of Contents
* [Technologies Used](#technologies-used)
* [Features](#features)
* [Usage](#usage)
* [Project Status](#project-status)
* [Room for Improvement](#room-for-improvement)
* [Acknowledgements](#acknowledgements)
* [Installation](#installation)
* [License](#license)## Technologies Used
[](https://skillicons.dev)
[](https://skillicons.dev)


## Features
- Sign Up and Login Form
- Auth
- Multiple responsive web pages
- Chatroom## Usage
`User is able to navigate to sign up form by clicking the Sign Up button.`
>
`User is able to navigate to login form by clicking the Login button.`
>
`User is able to see dashboard and then join or create a chatroom after login into the website.`
>
`User is able to have a real-time conversation while inside of the chatroom with another user(s).`## Project Status
Project is: _completed_## Room for Improvement
To do:
- User can add a picture to a profile
- User can see their profile picture in the chatroom## Acknowledgements
- This project was inspired by a random thought
- Many thanks to my teachers## Installation
See the appropriate guide for your environment and operating system.
- Flask or older Flask version
- Other frameworks that are not Flask, Bootstrap, Jinja2, SQLAlchemy
>
a. Flask Installation
>
Add Flask to your global or virutal enivorment:
For macOS:
`pip3 install flask`
For Windows:
`pip install flask`
- Make sure that Flask is the current version
- If using the virtual enivorment make sure to navigate to your folder that you create your env folder and activated your env
- You can activate your enivorment by typing `source/venv/bin/activate` and for Windows `.\env\Scripts\activate`
>
b. Boostrap Installation
> Add the link provided by Boostrap in your header located in your HTML file (this could also be your base file).
>
> ``
>
> Make sure to use version 5 as this is the latest version
>
c. Jinja/HTML/CSS Installation
> There is no installation needed for Jinja, HTML, CSS. When using Jinja just use {%%} to utilize Jinja.
> HTML and CSS is built into VSCode, while Jinja is Flask's official templating engine.d. SQLAlchemy/Socket.io Installation
> Add the link provided by Socket.io in your head tag located in your HTML file (this could also be your base file).
>
> ``
>
> SQLAlchemy can be installed by using `pip3 install flask_sqlalchemy` or `pip install flask_sqlalchemy`## License
- Licensed under Apache 2.0
[(Back to top)](#table-of-contents)