Peers

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support

• 📝 License

📖 Peers

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

🛠 Built With

Tech Stack

Client

• Jquery

Server

• Django

Database

• PostgreSQL

CI/Automation

• Github Actions

Deployment

• Nginx

Key Features

• 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.

(back to top)

🚀 Live Demo

• Demo

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

Atleast Python 3.6, Django 3.0.5, PostgreSQL 12.2

 sudo apt-get update && sudo apt-get install python3.6

Setup

Steps

• Create a folder with name peers on your local machine

mkdir peers
cd peers
git clone <url> .

• Create virtual environment for linux and MacOX

python3 -m venv venv

• Activate venv

. venv/bin/activate

for Windows

> mkdir peers
> cd peers
> py -3 -m venv venv

Activate for Windows

venv\Scripts\activate

• Install all project dependecies

pip install -r requirements.txt

Change database settings in settings.py to your database settings

• Run migrations

./cmd.sh m

• Run Server

./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

Preview

Run tests

To run tests, run the following command:

  ./cmd.sh test

(back to top)

👥 Authors

👤 Ayobami Alaran

• GitHub: Ayobami6
• Twitter: Ayobami Alaran
• LinkedIn: Ayobami Alaran

(back to top)

🔭 Future Features

• Search Posts
• Comment on Posts

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, help us by giving a ⭐️!

(back to top)

📝 License

This project is MIT licensed.

(back to top)