README.md

QuickTerms

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About QuickTerms
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • File Structure
3. Features
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This software is a web application that basically allows the generation of personalized terms and conditions and privacy policy documents. It is completely free and always will be. It will however, require the user to signup on our platform

Why is it relevant:

• Terms and Conditions and Privacy Policies are important legal documents required by businesses
• These documents are typically very long and are time consuming or expensive to write
• QuickTerms offers a free solution to the above problems 😄

(back to top)

Built With

This project is built with the following technologies, frameworks and languages

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

The steps below consist of instructions to get this project up and running on your local system

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• pip

  curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py

  python get-pip.py

• virtualenv

  pip install virtualenv

Installation

Now you would want to install all the projects dependencies

1. Create and activate a virtual environment

   python3 -m virtualenv “your environment name”

   source <path to virtual environment folder just created>/bin/activate

   OR

   <path to virtual environment folder just created>\Scripts\activate

2. Clone the repo

   git clone https://github.com/zuri-training/Proj-T_C_Gen-Team-74.git

3. Install dependencies

   pip install -r requirements.txt

4. Generate Django secret key

   • Start up a python shell from the terminal using the code

     python3 manage.py shell

   • Inside the shell that opens in the terminal type the following:

     from django.core.management.utils import get_random_secret_key
     print(get_random_secret_key())

   • Copy the generated output

5. Define your django secret key using the environment variable DJANGO_SECRET_KEY in a  .env file at the root of the project.

   DJANGO_SECRET_KEY='generated secret'
   

6. Define the required environment variables using the code below as an example

   SITE_URL='quickterms.zurifordummies.com'  // the production site URL
   HOST='quickterms.zurifordummies.com' // for configuring postgresql on django
   

7. Run the command python3 manage.py migrate to start up your database

8. Run the command python3 manage.py runserver to startup your server

(back to top)

File Structure

This is a brief explanation of our file structure

1. /quickterms/: This is the project folder it contains the settings.py file and other relevant files

2. /tc_site/: This is our app folder and contains all the static files, templates, models and forms for our site

3. /tc_site/static/: This contains all static files for our project

4. /tc_site/templates/: This contains all template files for our project split into blocks and pages.

5. /tc_site/models/: This contains all our database models

6. /tc_site/forms/: This contains all our model based forms

7. /tc_site/view_helpers/: This contains all logic for our function based views. It was created to separate the project logic and modularize the project.

8. /tc_site/views.py/: All view_helper modules and imported and executed in this file

(back to top)

Features

Our project provides these basic functionalities:

1. Ability to preview one of our templates as an unauthenticated user
2. Ability to generate either Terms and Conditions or Privacy Policy (For authenticated users)
3. Ability to export generated document as PDF or .docx (For authenticated users)
4. Ability to embed generated document into a user's website (For authenticated users)
5. Ability to share generated documents via custom generated link (For authenticated users)
6. Ability to view all generated documents (For authenticated users)
7. Ability to delete all generated documents (For authenticated users)
8. Accepting user feedback after succesful document generation.

Todo

• Send emails to users on request after document generation

For more details, please refer to the Documentation

(back to top)

Roadmap

• Setup project Skeleton (Ensuring modular file structure)
• Assign tasks to developers and designers
• Design the site
• Implement designs
• Implement fundamental backend functionalities
  • Authentication
  • File Generation
  • Embed
  • Export
  • Share
• Deploy on heroku
• Save and edit drafts later
• Delete generated documents
• Collecting feedback from users after file generation
• E-mail users after file generation

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)

Contact

For more information about this project you can contact @De_marauder on twitter or github or linkedin

Project Link: https://github.com/zuri-training/Proj-T_C_Gen-Team-74

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• I4GxZuri
• Django
• Heroku
• Font Awesome
• Bootstrap5

(back to top)

All Contributors Table

Contributors ✨

Thanks go to these wonderful people:

de-marauder and labodinho will be handling the main branch and merging of feature branches so you can perform your task in your own dedicated branches

Thank you everyone!

---

Ezike Obiajulu 💬 📖💻 👀 📢🚧	Olabode Oritogun 📖 👀	Ogunka Promise 📖	Obianuju Esther Onwuasoanya 💻	Nwankwo Akaolisa John 💻	Taiwo Akerele 📖	Wellington Chinechem 💻
Sodiq Ayobami Zubair 📖	Victor Ihetu 📖	Rasheed Olumide Elebute 📖
Enomfon Obot 💬	Omolara Akinbola 💬	Damilola Akinwunmi 💬	Quazeem Tiamiyu 💬	Irene Jilmari Stephen 💬	Omolade Odewunmi 💬	Victory Okelue 💬
Ibimina Georgewill 💬	Janet Oluwadamilola Adedigba 💬	Echenim Joy Chinyere 💬	Adebiyi Oladimeji 💬	Damola Olufowokan 💬	Agboola Esther Oreoluwa 💬

Relevant links

• Live site
• UX Research documention
• Figma
• Technical documentation
• Contributors details and their tasks
• Database Schema

LICENSE

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

MIT

(back to top)