Test app for importing contact information in CSV files.

About The Project

TestApp for importing contacts contained within a CSV file.

(back to top)

Built With

• Django
• Pandas
• Bootstrap

(back to top)

Getting Started

To install and run the TestApp, follow these instructions.

Prerequisites

• SQLite

  sudo apt install sqlite

• python

  sudo apt install python

• pipenv

  pip install pipenv

Installation

1. Install dependencies.

   pipenv sync

2. If project Venv wasnt activated automatically:

   pipenv shell

3. Create database and apply migrations.

   python csvtest/manage.py makemigrations
   python csvtest/manage.py migrate

4. Run server.

   python csvtest/manage.py runserver

Optional

Run tests

python csvtest/manage.py test -v 2

Run coverage analysis

coverage run csvtest/manage.py test -v 2
coverage html

Command will output the coverage report path.

(back to top)

Usage

1. Enter the project page at http://localhost:8000/
2. Upload CSV file and send it to server.
3. Map each CSV Column to a Contact field (It's fine to leave columns unmapped. They'll be saved nonetheless).
4. Confirm the mappings.

(back to top)

Roadmap (Or what I would've done with more time)

• Basic backend functionality.
• Logs.
• Basic front end.
• Documentation.
• Dockerization.
• Better logs.
• Model validation with Django-Ninja.
• Swagger API implementation.
• Better front end.

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

Sebastian Yanik - [email protected]

Project Link: https://github.com/DeLaboreMercurio/ImportContactsTestApp

(back to top)