https://github.com/HackAssistant/hackassistant

Hackathon registration server.
https://github.com/HackAssistant/hackassistant

django hacktoberfest python

Last synced: 2 months ago
JSON representation

Hackathon registration server.

• Host: GitHub
• URL: https://github.com/HackAssistant/hackassistant
• Owner: HackAssistant
• License: mit
• Created: 2022-07-03T15:56:57.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-01-29T23:47:32.000Z (12 months ago)
• Last Synced: 2024-08-02T07:09:50.377Z (6 months ago)
• Topics: django, hacktoberfest, python
• Language: Python
• Homepage:
• Size: 969 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-hackathon - HackAssistant - Hackathon registration server. (Platforms / Open Source 🌳)

README

        





  






📝 Hackathon registration server. Remake of the [HackAssistant/registration](https://github.com/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](/docs/README.md).

## 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)