"""
Nautiq is a web application that combines an interactive map with community-sourced information. Users can log beach conditions and discover new locations. The platform automatically generates tasks to encourage active participation. Through points, leaderboards, and achievements, Nautiq maintains user engagement and fosters a dynamic community. This sets it apart from competitors like Beachday or SwimGuide, which provide information but lack gamification and social interaction.
- About
- Features
- Installation
- Usage
- Contributing
- License
- About the competition
- Contact
Nautiq is designed to offer a fast and easy way to manage coastal data, optimize exploration, and visualize locations on an interactive map. The platform encourages community engagement and gamifies the beach discovery experience, making it both informative and fun.
- Local Django server for testing
- Database migrations with pre-configured scripts
- Configuration via .env file
- Preparation for integration with mapping services (Jawg Maps)
- Community-driven data input
- Gamification: points, leaderboards, achievements
Follow these steps to run Nautiq locally:
-
Clone the repository: git clone https://github.com/GeorgievIliyan/Nautiq
-
Create a virtual environment:
python -m venv venv
-
Activate the virtual environment:
venv\Scripts\activate
-
Install dependencies:
pip install -r requirements.txt
-
Configure environment variables: Create a .env file in the project root with the following content:
DJANGO_SECRET_KEY=<your-key> ENVIRONMENT=production JAWG_ACCESS_TOKEN=
💡 Notes:
DJANGO_SECRET_KEY– for local testing, you can use any random string.JAWG_ACCESS_TOKEN– needed for integration with Jawg Maps; token can be generated via the official Jawg website: https://www.jawg.io/en/
-
Open the project in your preferred code editor.
-
Run initial migrations:
python manage.py makemigrations
-
Apply migrations to the database:
python manage.py migrate
-
Start the local server:
python manage.py runserver
-
You should see: Starting development server at
http://127.0.0.1:8000/ -
Open your browser and visit:
http://127.0.0.1:8000
Once the server is running, you can explore Nautiq locally, add data, and test its features.
To contribute:
- Fork the repository
- Create a new branch (git checkout -b feature/YourFeature)
- Make your changes
- Submit a Pull Request
This project is licensed under the GNU-GPL-3 license. Open []
5/20-th place in the National Autumn Tournament in Information Technology 'John Atanasoff' (НЕТИТ "Джон Атанасов") in Bulgaria for grades IIX - X, software apps. 72/100 points.
Iliyan Georgiev – @GeorgievIliyan
Project: https://github.com/GeorgievIliyan/Nautiq