coders-hq / codershq

Social platform for developers to network, create and challenge themselves

Coders Headquarters

Index

• Introduction
• The Docs
• Quick Setup
• Getting up and running locally with Docker
• Prerequisites
• Build the Stack
• Run the Stack
• Execute Management Commands
• (Optionally) Designate your Docker Development Server IP
• Basic Commands
  • Setting up your users
  • Type Checks
  • Test Coverage
  • Celery
  • Email Server
• Stargazers
• Contributors

👋 Introduction

Coders Headquarters (CodersHQ) is a social platform for developers to grow, network, challenge themselves, and gain points by contributing and helping others in this community. This platform was built by the community and for the community. The essence of CodersHq is to inspire everyone to learn to code, share knowledge and learn together.

Currently the platform is at the alpha stage with a lot of the foundations being set. It is built using django and deployed using docker.

📄 The Docs

Have a look at the docs, we document everything over there. We plan to migrate from the docs to something more established, like readthedocs, once we have enough material to work with.

We also document the tasks in Notion and you can have a look at the issues section to find out what we are working on.

Back To Top ↥

⚙️ Quick Setup

Make sure you have Docker version 2+ and then do the following to build the stack and update the databse :

$ docker-compose -f local.yml build
$ docker-compose -f local.yml run --rm django python manage.py makemigrations
$ docker-compose -f local.yml run --rm django python manage.py migrate
$ docker-compose -f local.yml run --rm django python manage.py createsuperuser

Follow the rest of the README for more information and use /admin to edit and create challenges.

Back To Top ↥

🧑‍💻 Getting Up and Running Locally With Docker

The steps below will get you up and running with a local development environment. All of these commands assume you are in the root of your generated project.

Note

If you're new to Docker, please be aware that some resources are cached system-wide and might reappear if you generate a project multiple times with the same name.

Back To Top ↥

Prerequisites

• Docker; if you don't have it yet, follow the installation instructions;
• Docker Compose; refer to the official documentation for the installation guide.
• (Windows) This repository can run on windows and was tested on WSL2. Once you have WSL2, and a linux kernel, installed and running you need to install docker and you should be good to go. (Tested on Docker version 20.10.7, build f0df350 and Windows OS Build: 19042.1052)

Back To Top ↥

🏗️ Build the Stack

This can take a while, especially the first time you run this particular command on your development system::

$ docker-compose -f local.yml build

Generally, if you want to emulate production environment use production.yml instead. And this is true for any other actions you might need to perform: whenever a switch is required, just do it!

Back To Top ↥

Run the Stack

This brings up both Django and PostgreSQL. The first time it is run it might take a while to get started, but subsequent runs will occur quickly.

Open a terminal at the project root and run the following for local development::

$ docker-compose -f local.yml up

You can also set the environment variable COMPOSE_FILE pointing to local.yml like this::

$ export COMPOSE_FILE=local.yml

And then run::

$ docker-compose up

To run in a detached (background) mode, just::

$ docker-compose up -d

Back To Top ↥

Execute Management Commands

As with any shell command that we wish to run in our container, this is done using the docker-compose -f local.yml run --rm command: ::

$ docker-compose -f local.yml run --rm django python manage.py migrate
$ docker-compose -f local.yml run --rm django python manage.py createsuperuser

Here, django is the target service we are executing the commands against.

Back To Top ↥

(Optionally) Designate your Docker Development Server IP

When DEBUG is set to True, the host is validated against ['localhost', '127.0.0.1', '[::1]']. This is adequate when running a virtualenv. For Docker, in the config.settings.local, add your host development server IP to INTERNAL_IPS or ALLOWED_HOSTS if the variable exists.

Back To Top ↥

Basic Commands

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create an superuser account, use this command:

    $ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

    $ mypy codershq

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

    $ coverage run -m pytest
    $ coverage html
    $ open htmlcov/index.html

Running tests with py.test

    $ pytest

Celery

This app comes with Celery.

To run a celery worker:

    cd codershq
    celery -A config.celery_app worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog with a web interface is available as docker container.

Container mailhog will start automatically when you will run all docker containers. Please check cookiecutter-django Docker documentation for more details how to start all containers.

With MailHog running, to view messages that are sent by your application, open your browser and go to http://127.0.0.1:8025

Stargazers ⭐

Thanks to all of our Stargazers ⭐ 🔭 who are supporting CodersHQ project

Back To Top ↥

Contributors ✨

We would like to thank and appreciate our extraordinary contributors 👏

Rashed Suwaidi 💻 🎨 📆 🚇 🚧	Musab 💻	Abdulrahman Alblooshi 💻 🎨	Abdulkarim Suleiman 🖋	arsxl 💻 🔌	DerpySmurf 💻 🎨	haralali 📆
Kajal Doshi 💻 🚇	Khushboo Gehi 📆

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

codershq's Issues

Create a chat system for users to communicate

🏆 Task Description: Create a simple chat system that can be added to the tech stack
👨‍🚀 Skills Needed: Fullstack

---

Requirements

• basic chat feature that can be triggered when selecting a user
• can run separately
• it can be an api but must be hosted locally

Allow participants to join challenge as a team

Allow users to join a challenge as a team

Tie social accounts to user account after registering to CHQ

🏆 Task Description: Tie social accounts to user account after registering to CHQ
👨‍🚀 Skills Needed: Django

Create a company database class

🏆 Task Description: Create a new database class that defines what a company is
👨‍🚀 Skills Needed: Django

---

Requirement

• Create a new database class that defines what a company is
• link that company with a user base class
• Add a method for a user to become a company

signup/login messages of all users pile up and show for the first user that logs in successfully

Participate endpoint needs UI update

🏆 Task Description: Update the UI page of the participation endpoint
👨‍🚀 Skills Needed: HTML, CSS

---

UI update for /event/{id}/participate

Badge on completed Hackathon

Streamline CHQ events with eventbrite

🏆 Task Description: Combine CHQ events with eventbrite
👨‍🚀 Skills Needed: Python, API

---

Currently when there is an event it triggers an automate.io script to push the event to discord.
It would be better that once an event is created in the platform a signal is sent and a local bot pushes the event to discord.

Streamline Events

Events API Streamline

We need to streamline all the events into one clean process. To do this we must first connect coders hq with [eventbrite](https://www.eventbrite.com/) (the current event system). Eventbrite has [its own api](https://www.eventbrite.com/platform/docs/api-basics) and we need to create an event in the eventbrite system anytime an event is created in CHQ.

Wanted Process

1. Event is created in CHQ
2. A signal is sent to eventbrite (using django event model)
3. The signal contains all the details to create an eventbrite event

Testing Criteria

• Make a test account with eventbrite
• Make a local version of CHQ
• Create an event in the django admin page and it should create the same event in eventbrite

Reward

• contributor role in discord
• love and appreciation

Update ReadMe

Make the ReadMe more relevant with the right information to build.

Update challenge model to include sprints

Issue cards disappears in construction

Issue cards disappear construction after reloading the page if done multiple times

Setting account username to the social account name

🏆 Task Description: Link setting account username to the social account name
👨‍🚀 Skills Needed: Django

---

automatically setting the social account name to the username of the CodersHQ account could result in the following issue:

userA registers through CodersHQ with username:xyz without linking a social account.
userB with GitHub username:xyz will not be able to login with GitHub as the username was taken by userA.

Add contribution docs to wiki and as docs

The .yml files have a sphinx documentation tool and they need to filled with contribution information to help people contribute to CHQ

Create a scoring leaderboard

Event calendar for CHQ events

🏆 Task Description: Create a calendar which links to all events
👨‍🚀 Skills Needed: HTML, CSS

---

Currently CHQ has public events that people can join using an invite link. It would be good to have a single page that displays CHQ events with invite links.

Make grabbing github score more efficient

Create a requirement document for the blockchain incentive program

🏆 Task Description: Create a document with all the requirements needed for the project
👨‍🚀 Skills Needed: Blockchain, Crypto

---

We are planning to launch our very own currency which ties in with the rest of the platform. The idea is to have the currency integrate with the platform and automatically gives rewards based on contribution, participation and completion of different events and challenges. These rewards can later be cashed into a marketplace

To achieve this we need to start by first writing down what we are looking for in a program such as this one.

Improve ranking algorithm

Design Challenge Detail View

Create profile detail view

Connect to CodeChef and other websites through their API

Set scoring for users who link their coding challenge websites

Social login for gmail, LinkedIn, GitHub

🏆 Task Description: Create a social login for gmail, LinkedIn and GitHub
👨‍🚀 Skills Needed: Django

Allow user to link external coding challenge websites

Design Challenge List View and Detail View

Create Coders-HQ Ranking page

Create slack workspace and link slack API to this workspace

Auto generate certificate of attendance for event participants

🏆 Task Description: Auto generate certificate of attendance for event participants
👨‍🚀 Skills Needed: Python, Image Manipulation

• If someone joins an event there they can receive a certificate if they verify that they attended the event.
• Multiple events

Create Landing Page Content

Landing page content should have the basic information which would be useful to the user.

Design a dashboard that connects every part of CHQ that shows basic data

🏆 Task Description: Dashboard design and prototype
👨‍🚀 Skills Needed: CSS, HTML, Figma

---

There is so many things happening on the platform. We need a dashboard design that can connect all of them and display it in one place.

📝 Submission Requirements

• Dashboard design using tailwind CSS
• (optional) dark mode
• must show: events up coming, challenges joined, score, basic profile information, any extra info that makes sense

Adding User Settings in Database

It would be better if the data was passed to the root html file in codershq/templates/base.html

• themePreference (can be text/varchar): default value would be light and dark would be an option
• languagePreference (also text/varchar): default value would be en and ar would be an option

/static/avatars directory missing

images from /static/avatars directory are referenced in home.html but the directory does not exist

Define Hackathon in Docs

Implement Challenge Detail view

Allow users to form teams through the chat

Add GitHub score on the dashboard

Make GitHub score part of the dashboard and make it stand out since we don't have a lot of other content

Limit scoring

Add function to limit points in scoring in any one dimension. So someone who has large commits should not dominate the scoring.

add search for hackathon list view

Implement Challenge list and Detail View

Test Issue for WIP Page

This is a test

Show more user data/statistic on main page

The main landing page should be populated with more data and infographic showing relevant information related to the user.

Update sign in/sign up and sign out UI

The UI doesn't match the rest of the UI. We need to update it to look similar to the landing page.

Create dashboard

Theme simple profile page

Bug: Github URLs with https:// are invalid profiles

I tried typing a Github URL in the Edit Profile without https:// it works fine but when I use it, it says wrong profile.. this is in user_form.html (../users/~update/)

This works:

This does not work:

Allow users to form a team with other users

Add a contributors section in the home page

🏆 Task Description: Add a section in the landing page to showcase CHQ contributors
👨‍🚀 Skills Needed: HTML, CSS

---

We need to add a section after the partners in the home page which shows the lead contributors with

a picture / small bio / and a social media account

The contributors are also discord admins.

create overall Coders-HQ theme

Theme Hackathon ListView