Skip to content

Latest commit

 

History

History
221 lines (173 loc) · 7.55 KB

README.md

File metadata and controls

221 lines (173 loc) · 7.55 KB
Raw

PRO_Act

Issues PRs Welcome

Pro_Act provides you with an efficient way of managing your tasks. It works on the principles of divide and conquer, allows the user to enter tasks, and then divide them into further sub-tasks and handle them efficiently! Best when working with a team to be updated about the tasks that are completed and those that are yet to be done.

Color scheme : https://colorhunt.co/palette/269111

Getting Started ✔

  • Create and activate the Virtual Environment at your desired path as follows : py -m venv env(on Windows) or python3 -m venv env(on Mac and Linux)
  • Activate the Virtual Environment : .\env\Scripts\activate(for Windows) or source env/bin/activate(on Mac and Linux)
  • Then fork this repository to your account
  • Clone it in your local machine using command git clone url
  • Navigate to the project directory and install the project requirements using pip install -r requirements.txt
  • After a copy of the project is made in your machine , follow the Explore section to run the project in your local server.
  • All pages are present in the templates folder , project files in the pro_act folder.
  • Make the required changes and run it in the server to see the working.
  • git add . to add all the changes and git add filename.txt to add changes to a particular file.
  • git commit -m "message" it is recommended to commit with a message to tell what are the things you have changed.
  • git push to push all changes to main branch from local branch.

PS: Virtual Environment can be installed on windows by py -m pip install --user virtualenv

Explore 🌏

Try it out by installing Django. (It is required to have Python installed , if not then download it from : here)

python -m pip install Django

After installation of Django, open this file in any text editor and in the teminal type the following commandes to migrate the file . Migrate the files:

python manage.py makemigrations
python manage.py migrate

And then start the server (default: http://localhost:8000)

python manage.py runserver

Lint and Format 📜

  • We use Flake8 and Black for linting & formatting source code of this project.

- **Run QA checks on local environment ⚡** :
  • Run Shell script on Windows 💾 :
...\PRO_ACT> .\proAct_qa_checks
  • Run Shell script on Linux 👨‍💻 :
.../PRO_ACT$ ./proAct_qa_checks
  • Alternate option ✔ :
    • Run this on terminal ⚡:
      • Windows 💾 
        ...\PRO_ACT> black .

        ...\PRO_ACT> flake8 .
      • Linux 👨‍💻 
        .../PRO_ACT$ black .

        .../PRO_ACT$ flake8 .

Work Flow ⚡

  • First the user needs to login to the page, if one is logged in they will be redirected to the dashboard else to the log-in page.
  • If one has not signed up they may do it using the sign-up page and then log in.
  • Now the dashboard contains a navbar and a welcome message in its body.
  • In the project tab, there is an option to add and view projects.
  • The added project consists of a form to enter the details of the project.
  • The view page consists of cards containing project details.
  • This page will also have an option of adding sub-tasks to the projects.

Project Tree Structure 📁

 Project tree structure 👇 

PRO_Act/📑
┣ assets/📂
┃ ┣ logosvgfile.svg
┃ ┣ Pro act new logo.png
┃ ┗ Pro_Act-LOGO1.png
┣ home/📂
┃ ┣ templatetags📂
┃ ┣ ┗ format_datetime.py
┃ ┣ admin.py
┃ ┣ apps.py
┃ ┣ forms.py
┃ ┣ models.py
┃ ┣ signals.py
┃ ┣ urls.py
┃ ┗ views.py
┣ media/📂
┃ ┣ cover.png
┃ ┗ readme
┣ pro_act/📂
┃ ┣ asgi.py
┃ ┣ settings.py
┃ ┣ urls.py
┃ ┗ wsgi.py
┣ static/📂
┃ ┣ css/📁
┃ ┃ ┗ moduleStyle.css
┃ ┣ favicon/📁
┃ ┃ ┗ favicon-32x32.png
┃ ┣ images/📁
┃ ┃ ┣ logo/📁
┃ ┃ ┃ ┣ PRO_ACT_Bck.png
┃ ┃ ┃ ┗ PRO_ACT_Bck.svg
┃ ┃ ┣ add.png
┃ ┃ ┣ google.png
┃ ┃ ┣ module.png
┃ ┃ ┣ timer.png
┃ ┃ ┣ update.png
┃ ┃ ┗ user.png
┃ ┗ js/📁
┃   ┣ modules.js
┃   ┣ register.js
┃   ┗ reset-pwd.js
┣ templates/📁
┃ ┣ emails/📁
┃ ┃ ┣ otp.html
┃ ┃ ┗ welcome.html
┃ ┣ about.html
┃ ┣ base.html
┃ ┣ changepassword.html
┃ ┣ contact.html
┃ ┣ forgot-password.html
┃ ┣ index.html
┃ ┣ login.html
┃ ┣ modules.html
┃ ┣ profile.html
┃ ┣ profile_update.html
┃ ┣ project_add.html
┃ ┣ project_view.html
┃ ┣ signup.html
┃ ┣ style.css
┃ ┣ todo2.jpg
┃ ┗ todo3.jpg
┣ .flake8
┣ .gitignore
┣ proAct_qa_checks
┣ contributing.md
┣ Contributors.md
┣ db.sqlite3
┣ manage.py
┣ Pro_act compact logo
┣ README.md
┗ requirements.txt

For a better idea on how to contribute 🤩 click here!

Tech Stacks 👨‍💻

HTML5 Python JavaScript CSS3 Django SQLite

❤️ Project Admin
Sruti Chatterjee

Contributors ✨

Credits go to these wonderful peoples !!!