https://github.com/ayobami6/peersonline
Peers is a website that helps Alx Students of software engineering learn better, faster and do hard stuffs easily with colleagues and peers of the same cohort and different cohorts
https://github.com/ayobami6/peersonline
ai django django-application django-rest-framework gpt-3 portfolio project python3 social-network
Last synced: about 2 months ago
JSON representation
Peers is a website that helps Alx Students of software engineering learn better, faster and do hard stuffs easily with colleagues and peers of the same cohort and different cohorts
- Host: GitHub
- URL: https://github.com/ayobami6/peersonline
- Owner: Ayobami6
- License: mit
- Created: 2023-06-16T16:27:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-18T09:34:12.000Z (over 2 years ago)
- Last Synced: 2025-07-21T04:42:10.299Z (11 months ago)
- Topics: ai, django, django-application, django-rest-framework, gpt-3, portfolio, project, python3, social-network
- Language: JavaScript
- Homepage: https://ayobami.pythonanywhere.com/
- Size: 5.74 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Peers
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [📝 License](#license)
**Peers** is a website that helps Alx Students of software engineering learn better, faster and do hard stuffs easily with colleagues and peers of the same cohort and different cohorts
Client
Server
Database
CI/Automation
Deployment
- **Learn**: This is a feature that allows student to learn with colleagues and peers on different tasks
- **Mentor**: This is a feature where peers can register to mentor others on a particular concept they want to talk about and teach, when a mentor register to mentor, all members of peers gets notified of the new mentor session.
- **Ask gpt**: This feature allows members of peers to ask chat gpt for advice on anything relating to software engineering alone, anything aside that gpt won't respond with what they expect.
- **Post**: This features allows members to post questions, articles, react to posts and comments
and more.
- [Demo](https://beta.peersonline.tech)
### Prerequisites
In order to run this project you need:
Atleast Python 3.6, Django 3.0.5, PostgreSQL 12.2
```sh
sudo apt-get update && sudo apt-get install python3.6
```
Steps
- Create a folder with name peers on your local machine
```bash
mkdir peers
cd peers
git clone .
```
- Create virtual environment for linux and MacOX
```bash
python3 -m venv venv
```
- Activate venv
```bash
. venv/bin/activate
```
for Windows
```bash
> mkdir peers
> cd peers
> py -3 -m venv venv
```
Activate for Windows
```bash
venv\Scripts\activate
```
- Install all project dependecies
```sh
pip install -r requirements.txt
```
Change database settings in settings.py to your database settings
- Run migrations
```sh
./cmd.sh m
```
- Run Server
```sh
./cmd.sh run
```
Then open the generated port and host with your web browser with localhost/
Like this
```
http://127.0.0.1:8000/
```
If you encouter an issue setting up
create an Issue [here](https://github.com/Ayobami6/Peersonline/issues)
**Preview**
### Run tests
To run tests, run the following command:
```sh
./cmd.sh test
```
👤 **Ayobami Alaran**
- GitHub: [Ayobami6](https://github.com/Ayobami6)
- Twitter: [Ayobami Alaran](https://twitter.com/ayobamialaran)
- LinkedIn: [Ayobami Alaran](https://linkedin.com/in/ayobami-alaran)
- [ ] **Search Posts**
- [ ] **Comment on Posts**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Ayobami6/Peersonline/issues/).
If you like this project, help us by giving a ⭐️!
This project is [MIT](./LICENSE) licensed.