AchievementHQ-README

Keep track of all your achievements, no matter how big or small they are! 🎯 Achievement HQ is a social network for you and your friends to track and celebrate each other's achievements!

View Demo »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Welcome to the official repository for AchievementHQ! AchievementHQ is a social network designed to help you and your friends track, share, and celebrate each other's achievements. Whether it's personal milestones, professional goals, or just daily wins, AchievementHQ makes it easy and fun to stay motivated and connected.

Features:

• Achievement Tracking: Log and monitor your progress on various goals
• Social Sharing: Share your achievements with friends and celebrate their successes
• Notifications: Stay updated with reminders and notifications about your and your friends' milestones 😄 (if feature is requested)
• Customizable Profiles: Personalize your profile to showcase your top achievements and unique journey (if feature is requested)
• Privacy Controls: Manage who sees your achievements and ensure your data is secure (if feature is requested)

Thank you for your interest in AchievementHQ! We look forward to celebrating your achievements together!

(back to top)

Built With

Python Django and Bootstrap

• 
• 

(back to top)

Getting Started

To get a copy set up and running on your local environment follow these simple steps.

Prerequisites

The project requires Python 3 and pipenv to be installed on your local machine.

• Install pipenv

  pip install pipenv

Installation

1. Download repository

git clone https://github.com/monatemedia/python-django-achievementhq.git

2. Change into main directory

cd python-django-achievementhq

3. Create Venv

pipenv shell

4. Change into app directory

cd achievementhq

5. Run the demo app

python demo.py

• Admin user name is "admin" and password is PennantFernlikeAnnouncerSubsidy
• All other users passwords are DecreasePrototypeEasiestOxidant

(back to top)

Usage

Logged in users can view all other users by their latest posts:





Logged in users can post and delete their own achievement posts:



Posts are organised on a timeline:



Logged in users can make and delete their comments on their own and other users achievement posts:



Comments are organised on a timeline by post:



Logged in users can delete comments made on posts they own:



Administrators can log into the admin area at http://127.0.0.1:8000/admin/ and create, read, update and delete:

• Users
• User Groups
• Polls
• Posts
• Comments
  
  
  For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add Pages App
  • Logged Out Pages
    • Home Page
    • Resume Page
    • Projects Page
    • Contact Page
      • Set Up Mail Server
    • Privacy Page
    • Terms Page
• Add Polls App
  • Add Polls Pages
    • Add Polls Index Page
    • Add Polls Details Page
    • Add Polls Results Page
  • Set Up Polls In Admin Area
• Add Posts App
  • Add Posts Pages
    • Posts Index Page
    • Posts User List By Latest Post Page
    • Posts Detail Page
    • Posts Form Page
  • Add Comments Pages
    • Comments Detail Page
    • Comments Form Page
  • Add Delete Confirmation Page For Posts & Comments
  • Set Up Posts And Comments In Admin Area
• Add Users App
  • Add Sign Up Page
  • Add Log In Page
• Add Error Pages
  • Add 404 Not Found Page
  • Add 500 Server Error Page
• Error Logging
• Pagination
• Mail Server
• Update demo.py To Run collectstatic
• Set Up Docker Container
• Send Container To VPS
• Map URL to IP Address

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Edward Baitsewe - @LinkedIn - Website

Project Link: https://github.com/monatemedia/python-django-achievementhq

(back to top)

Acknowledgments

A list of resources that I found helpful and inspirational!

• Brad Traversy Python Django Crash Course
• Brad Traversy Python Django Crash Course Gist With Commands
• GeeksforGeeks Django Sign Up and Login With Confirmation Email
• Aman Goyal How To Create A Timeline To Track Your Achievements
• Start Bootstrap Theme Personal
• The Django Software Foundation Django Project
• Material Design For Bootstrap (Bootstrap 5) Registration Form Component
• Othneil Drew Best README Template

(back to top)