Skip to content

HackAssistant/hackassistant

Repository files navigation


HackAssistant


📝 Hackathon registration server. Remake of the HackAssistant/registration in order to improve the future development and maintainability.

Features

  • Email sign up ✉️
  • Email verification 📨
  • Forgot password 🤔
  • Ip block on failed login tries & ip blocklist ✋ (Optional)
  • Dark mode 🌚 🌝 Light mode (Optional)

Documentation

There's a really extended documentation for configurations or development of the application here.

Development

The development if this Django app can be made by Python or Docker-Compose. We recommend the use of Docker.

Docker-Compose

Needs: Docker, Docker-Compose

  • ./install.sh (Creates virtualenviroment, install requirements.txt and migrates DB)
  • docker-compose up (Starts server)

That is all! 😃 If you need to run any python command just do as the following examples:

  • Install new library: docker-compose run python -m pip install [library]
  • Make migrations: docker-compose run python manage.py makemigrations
  • Migrate: docker-compose run python manage.py migrate

Python

Needs: Python 3.X, virtualenv

Stable at Python v.3.8.X and 3.10 (tested at Python 3.8.17 and 3.10)

  • git clone [email protected]:HackAssistant/hackassistant.git && cd hackassistant
  • virtualenv env --python=python3
  • source ./env/bin/activate
  • pip install -r requirements.txt
  • python manage.py migrate
  • python manage.py createadmin (creates admin to manage all the app: CUSTOM COMMAND!)
  • python manage.py runserver localhost:8000 (specifies to localhost, since admin is created under that specific domain, otherwise it wont work)