PeerSupport is an anonymous peer support chat application that allows users to message each other without the worry of their identity being known by their peers. Users can flag risky messages (e.g. Suicidal Ideation, Potential Violence, Harassment), which only monitor admins (e.g. school counselors) can view and decide the best course of action to ensure a safe environment. The flagging of messages can also be done by a machine learning algorithm.
Docker & Docker-Compose are needed in order to run this application. You can download Docker here and Docker-Compose here. Make sure to follow the directions according to the system you are running the application on.
To clone the repository, run the following command after downloading git here :
git clone https://github.com/IanSteenstra/PeerSupport.git
Run the following commands inside the root directory:
docker-compose builddocker-compose up
You can now view the main website at http://127.0.0.1 and the Django Admin Page at http://127.0.0.1/api/admin/.
In case you need to make migrations to the database or create a superuser, who will need to connect to the running backend server.
- In another terminal, while the servers are still running, enter
docker ps - Find the Container ID for the peersupport_backend server (ex: db54a724e9a4)
- Run
docker exec -it <container ID> bash - Run your desired commands (ex:
python manage.py migrate,python manage.py createsuperuser)
If Nginx is giving an error after running docker-compose up, you may need to turn filesharing on for the entire directory of the application. For help, look under FILE SHARING here.
PeerSupport is licensed under the terms of the MIT license and is available for free.