README.md

Project Contacts Django

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

This project was a way to acquire knowledge with django and python using the Boostrap framework as FrontEnd. This project was based on google contacts.

• Contacts Google

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Usage

1.User login page.

2.User Register page.

3.User Home Page.

4.Search Contacts.

5.Contact creation page.

6.Contact Detail page.

7.Created contact edit page.

8.Contact Delete.

9.Import Contacts.

10.Export Contacts.

11.Export Contacts for excel.

12.Print Out Contacts.

(back to top)

Prerequisites

• Python

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/HeitorLouzeiro/contact-django.git

2. Access the project folder in terminal/cmd

   cd contact-django

3. Create a virtualenv with Python 3.9.0.

   python -m venv venv

4. Activate virtualenv.

   • Ubunto

   source venv/bin/activate

   • MacOs

   source venv/bin/activate

   • Windows

    venv\scripts\activate

5. Install as dependencies.

    pip install -r requirements.txt

6. Configure an instance with .env.

    cp env-example .env

   or

   Copy the env-example to a new file called .env and then open it and change the variable values ​​if necessary

7. Run the migrations.

    python manage.py migrate

8. Create a Superuser.

    python manage.py createsuperuser

9. Run the application.

    python manage.py runserver

10. Run the tests.

     python manage.py test 

    or

     ptw 

(back to top)

Roadmap

• Login User
• Register User
• View Contact
• Create Contact
• Detail Contact
• Edit Contact
• Delete Contact
• Search Contact
• Import Contact
• Export Contact
• Print Out Contact

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/Improvements)
3. Commit your Changes (git commit -m 'Add my new Enhancements')
4. Push to the Branch (git push origin feature/Improvements)
5. Open a Pull Request

(back to top)

Collaborators

We thank the following people who contributed to this project:

Heitor Louzeiro

(back to top)

License

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

(back to top)

Contact

Project Link: https://github.com/HeitorLouzeiro/contact-django

(back to top)